ToPSync Memory Mapped API Documentation Revision: Major 4, Minor 5

MAIN BLOCKS

Value Description
0x00 Debug Diagnostics Configuration
0x01 System Management Configuration
0x02 Clock Inputs Configuration
0x03 Clock Outputs Configuration
0x04 Network Interface 1 Configuration (physical port 0, virtual port 0)
0x05 Network Interface 2 Configuration (physical port 1, virtual port 0)
0x07 Time Of Day Interface 1 Configuration
0x08 Time Of Day Interface 2 Configuration
0x09 Local Oscillator Configuration
0x0A PTP Slave Port 1 Configuration
0x0B PTP Slave Port 2 Configuration
0x0C PTP Master Port 1 Configuration
0x0D PTP Master Port 2 Configuration
0x12 Acceptable Master Table 1 Configuration
0x13 Visible Master Table 1 Configuration
0x14 PTP PLL 1 Configuration
0x15 Acceptable Master Table 2 Configuration
0x16 Visible Master Table 2 Configuration
0x17 PTP PLL 2 Configuration
0x1E Acceptable Slave Table 1 Configuration
0x1F Acceptable Slave Table 2 Configuration
0x22 Network Master Table Configuration
0x23 Clock PLL 1 Configuration
0x24 Clock PLL 2 Configuration
0x27 Node Time 1 Configuration
0x28 Node Time 2 Configuration
0x29 TDM (eSETS) Configuration
0x2A Alarm Configuration
0x2B Network Configuration
0x2C NTP Configuration
0x32 Virtual interface Configuration (physical port 0, virtual port 1)
0x33 Virtual interface Configuration (physical port 0, virtual port 2)
0x34 Virtual interface Configuration (physical port 0, virtual port 3)
0x35 Virtual interface Configuration (physical port 0, virtual port 4)
0x36 Virtual interface Configuration (physical port 0, virtual port 5)
0x3C Virtual interface Configuration (physical port 1, virtual port 1)
0x3D Virtual interface Configuration (physical port 1, virtual port 2)
0x3E Virtual interface Configuration (physical port 1, virtual port 3)
0x3F Virtual interface Configuration (physical port 1, virtual port 4)
0x40 Virtual interface Configuration (physical port 1, virtual port 5)
0xD0 Image upload control
0xE0 ACS 1790 Configuration

Debug Diagnostics Configuration : Sub Blocks

[Back to index]
Start Address Description
0x00000000 Register Map
0x00008000 System debug
0x0000C000 Lcd Display Settings
0x00010000 I2C Access for debug only
0x00014000 Direct DAC control for debug only
0x00018000 ECC Settings
0x0001C000 SPI error setting

Debug Diagnostics Configuration : Register Map

[Back to index | Back to parent block]
Address Name RW Default Description
0x00000000 Test Register 1 RO 0x736D7473 Bits[31:24] = 0x73 's'
Bits[23:16] = 0x6D 'm'
bits[15:8] = 0x74 't'
Bits[7:0] = 0x73 'c'
0x00000001 Test register 2 RW 0x00000000 Bits[31:0] = Determined by user (This register is a scratch pad provided as a debug
aid during initial board bring up. Accessing this register does not affect
normal ToPSync operation.
0x00000002 Register Map Revision number (Major/Minor Rev) RO 0 Bits[31:16] = Major revision number
Bits[15:0] = Minor revision number
0x00000003 Reserved - - Reserved

Debug Diagnostics Configuration : System debug

[Back to index | Back to parent block]
Address Name RW Default Description
0x0000800A control register for debug controller RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface configured for debug. Valid values are:
0 - disable debug controller on a network interface
1 - enable debug controller on a network interface. This means that the debug controller will be listening for
debug requests on the network interface.
0x00008010 network physical interface for debug controller RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface used for debug. This should only be set when the debug port is disabled.
Valid values are:
0 - network interface 0
1 - network interface 1
0x00008011 network protocol for debug controller RW 0 Bits[31:1] = Reserved
Bits[0:0] = network protocol used for debug. This should only be set when the debug port is disabled.
Valid values are:
0 - udp over ipv4
1 - udp over ipv6
0x00008012 Reserved - - Reserved
0x00008013 Reserved - - Reserved
0x00008014 network virtual interface for debug controller RW 0 Bits[31:3] = Reserved
Bits[2:0] = virtual network interface used for debug. This should only be set when the debug port is disabled.
0x00008015 network multi home index for debug controller RW 0 Bits[31:4] = Reserved
Bits[3:0] = multi home index used for debug. This should only be set when the debug port is disabled.
0x00008016 UDP port used for debug controller RW 323 Bits[32:16] = Reserved
Bits[15:0] = UDP Port used by debug controller. This should only be set when the debug port is disabled.

Debug Diagnostics Configuration : Lcd Display Settings

[Back to index | Back to parent block]
Address Name RW Default Description
0x0000C000 The length of time for which each screen is displayed on the LCD RW 1 Bits[31:0] = Time in secs as a float
Notes: The minimum period is 0.5s
0x0000C001 The bit mask configures which of the LCD screens to display RW 0x1FF Bits[31:9] = Reserved
Bits[8:0] = Each represents which screen to display from the below values. It will not allow all the screens to be disabled.
LCD_BIT_PTPSLAVE1 0x1
LCD_BIT_PTPSLAVE2 0x2
LCD_BIT_PTPMASTER1 0x4
LCD_BIT_PTPMASTER2 0x8
LCD_BIT_NODETIME1 0x10
LCD_BIT_NODETIME2 0x20
LCD_BIT_CLOCKPLL1 0x40
LCD_BIT_CLOCKPLL2 0x80
LCD_BIT_GENERAL 0x100
LCD_BIT_USER_DATA 0x2000
0x0000C002 This freezes the currently displayed LCD screen RW 0x0 Bits[31:1] = Reserved
Bits[0:0] = 0 - LCD will behave normally and each screen is displayed in turn
1 - only the current LCD screen will be displayed

Notes: If a LCD selection switch is fitted in hardware and Freeze is selected by it, then this software selection has no effect
0x0000C020 Chars 0 to 3 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
Notes: eg in the string 'hello' the character 'h' will reside in Bits[31:24]
0x0000C021 Chars 4 to 7 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C022 Chars 8 to 11 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C023 Chars 12 to 15 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C024 Chars 16 to 19 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C025 Chars 20 to 23 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C026 Chars 24 to 27 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C027 Chars 28 to 31 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C028 Chars 32 to 35 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C029 Chars 36 to 39 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C02A Chars 40 to 43 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C02B Chars 44 to 47 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C02C Chars 48 to 51 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C02D 52 to 55 Chars to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C02E Chars 56 to 59 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char
0x0000C02F Chars 60 to 63 to be displayed on lcd display for user data RW 0 Bits[31:24] = 1st char
Bits[23:16] = 2nd char
Bits[15:8] = 3rd char
Bits[7:0] = 4th char

Debug Diagnostics Configuration : I2C Access for debug only

[Back to index | Back to parent block]
Address Name RW Default Description
0x00010000 Are certain I2C addresses denied through this API? RW 0x1 Bits[31:1] Reserved
Bit[0] '1' - The I2C address between 0x00010001 and 0x00010002 inclusive are locked and cannot be accessed via this API.
'0' - All I2C addresses are accessible through this API.
0x00010001 Lowest I2C address denied access through this API RO 0x60 Bits[31:7] Reserved
Bits[6:0] The lowest I2C address that cannot be accessed (is protected) through this API, if protection is enabled (0x00010000). The address does not include the read|write bit.

Notes: The address does not include the read/write bit.
0x00010002 Highest I2C address denied access through this API RO 0x63 Bits[31:7] Reserved
Bits[6:0] The highest I2C address that cannot be accessed (is protected) through this API, if protection is enabled (0x00010000). The address does not include the read|write bit.

Notes: The address does not include the read/write bit.
0x00010003 Address to which register (optional) and data (required) will be read or written from RW NA Bits[31:7] Reserved
Bits[6:0] The I2C address to read or write from. The address must not include the readwrite bit.

Notes: The address must not include the read/write bit.
Notes: The I2C access only takes place when the register 0x00010005 is read or written. This register / must be setup prior to this.
0x00010004 Register to which data will be read or written RW NA Bit[31] '1' - Use the register address in the I2C access, '0' - register not used in access.
Bits[30:16] Reserved
Bits[15:0] The register to be read from or written to.

Notes: The I2C access only takes place when the register 0x00010005 is read or written. This register must be setup prior to this.
0x00010005 Data to write or that is read from the address & register values RW NA Bits[31:8] Reserved
Bits[7:0] If register is written the value is written to the device at the address specified in register 0x00010003 and register specified in 0x00010004.
0x00010006 Last error to occur RO 0 Bits[31:0] Valid decimal values and meanings:
0 - Success
1 - OS failure
2 - I2C Module Busy
3 - A parameter was out of range or invalid
4 - The slave address was invalid
5 - A timeout occurred waiting for r/w to complete
6 - Slave did not acknowledge it's address
7 - Slave did not acknowledge a register r/w
8 - Slave did not acknowledge a data write
9 - Reserved
10 - General error (generally indicated fatal condition)

Debug Diagnostics Configuration : Direct DAC control for debug only

[Back to index | Back to parent block]
Address Name RW Default Description
0x00014000 Enable or disable the DAC output RW 0 Bits[31:1] = Reserved
Bits[0] = Bit value '1' turns DAC on, '0' turns DAC off.
0x00014001 Read/write the DAC control word offset RW 0 Bits[31:16] = Not used
Bits[15:0] = Dac offset as signed 16-bit integer. This is the offset applied to the DAC central control value 1<<15.

Debug Diagnostics Configuration : ECC Settings

[Back to index | Back to parent block]
Address Name RW Default Description
0x00018000 enable ecc insertion error RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = Writing 0x5A will enable insertion errors
These ECC items only apply to ACS9520 with ECC memory fitted and enabled
0x00018001 generate ecc insertion error WO 0x0 Bits[31:1] = Reserved
Bits[0:0] = Bit value '1' generates an insertion error, '0' for normal operation
These ECC items only apply to ACS9520 with ECC memory fitted and enabled
0x00018002 bitfield for SDRAM bits to be errored RW 0 Bits[31:0] = If 1st bit is 1 then SDRAM bit 0 is to be error, if 32nd then SDRAM bit 31 is to be errored
These ECC items only apply to ACS9520 with ECC memory fitted and enabled
0x00018003 read ecc double error RO 0 Bits[31:1] = Reserved
Bits[0:0] = Bit value '1' means there is an ecc double insertion error
These ECC items only apply to ACS9520 with ECC memory fitted and enabled
0x00018004 read ecc single error count RO 0 Bits[31:8] = Reserved
Bits[7:0] = Count of single errors
These ECC items only apply to ACS9520 with ECC memory fitted and enabled
0x00018005 clear ecc error WO 0 Bits[31:1] = Reserved
Bits[0:0] = Bit value '1' clears an ecc error
These ECC items only apply to ACS9520 with ECC memory fitted and enabled

Debug Diagnostics Configuration : SPI error setting

[Back to index | Back to parent block]
Address Name RW Default Description
0x0001C000 Store the SPI error R 0 Bits[31:0] Valid decimal values and meanings:
0 - Success
1 - Spi Driver is not initialised
2 - Data Link protocol is not initialised
3 - Shared Memory Access protocol is not initialised
4 - A buffer overflow has occurred due to an invalid message size passed to the driver
5 - A memory allocation call has failed
6 - A data link frame of unknown type has been received and discarded
7 - A data link frame of invalid size has been received
8 - A data link frame has been received with a CRC error
9 - A SMP fragment of invalid size has been received
10 - A timeout occurred while attempting to transmit a SMP fragment
11 - An unknown error has occurred
0x0001C001 Store the Function of the SPI error R 0 Bits[31:0] Valid decimal values and meanings:
0 - Success
1 - TheFunction of SPI_SEND_MESSAGE
2 - TheFunction of SPI_CONSTRUCT_DLK_FRAME
3 - TheFunction of SPI_SEND_FRAME
4 - TheFunction of SPI_SEND_FRAGMENT
5 - TheFunction of SPI_FRAME_RECEIVED
6 - TheFunction of SPI_FRAGMENT_RECEIVED
0x0001C002 Store the time of the SPI error R 0 Bits[31:0] = Elapsed time in seconds since the last reset of the DpSync device
0x0001C003 Reserved - - Reserved
0x0001C004 Reserved - - Reserved

System Management Configuration : Sub Blocks

[Back to index]
Start Address Description
0x01000000 Application Parameters
0x01004000 Boot Parameters
0x01008000 Initial System Configuration Parameters
0x0100C000 Initial System Configuration Parameters for Port 0
0x01010000 Initial System Configuration Parameters for Port 1
0x01014000 Initial System Configuration Parameters for PTP
0x01018000 System Configuration Parameters for PTP Delay Measurement and Error Counter
0x0101C000 System Configuration Parameters for Binary Lock and Alarm Output pins
0x01020000 External voltage controlled oscillator control
0x01024000 Control interface
0x0102C000 Plug & Play Configuration
0x01030000 ptp 8265.1 & 8275.1 profile configuration

System Management Configuration : Application Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x01000000 Hardware Version RO 0 Bits[31:0] = Hardware Version e.g. 95020200
0x01000001 Application Software Version RO 0 Returns 16 character Software Version
Bits[31:0] = First 4 characters (e.g. 'ts2A' if Software Version = 'ts2ApiDev_dc1')
0x01000002 Application Software version RO 0 Bits[31:0] = Characters 5 to 8 (e.g. 'piDev' using above example)
0x01000003 Application Software version RO 0 Bits[31:0] = Characters 9 to 12 (e.g. 'v_dc' using above example)
0x01000004 Application Software version RO 0 Bits[31:0] = Characters 13 to 16 (e.g. '1 ' using above example)
0x01000005 ToPSync System State RW 0 Bits[31:0] = ToPSync State (e.g. TOPSYNC_BOOT_STATE, TOPSYNC_RUNNING_STATE etc.)
Permitted values:
0 - BOOT Initial POR state
1 - INITIALISING SYSTEM System is being initialised
2 - INITIALISING APPLICATION Application is being initialised
3 - RUNNING Application is running
4 - SOFTWARE CORRUPT CRC check of the application image has failed
5 - EXCEPTION A fatal exception has been detected
0x01000006 Time in seconds since last reset RO 0 Bits[31:0] = Elapsed time in seconds since the last reset of the ToPSync device
0x01000007 Network Upload Flag RO 0 Bits[31:1] = reserved
Bits[0] = Network Upload Flag
Permitted values:
0 - Indicates that SPI Uploaded Application is running
1 - Indicates that Network Uploaded Application is running
0x01000010 Module Serial Number ACS9860 parts only RO 0 Serial number comprise 12 ASCII encoded bytes [0,1,2,3,4,5,6,7,8,9,10,11], eg:'A114370001-08' where byte 0 = 'A'(0x41), byte 1 = '1'(0x31), byte 11 = '8'(0x38)
Bits[31:24] = byte 0
Bits[23:16] = byte 1
Bits[15:8] = byte 2
Bits[7:0] = byte 3
0x01000011 Module Serial Number ACS9860 parts only RO 0 Bits[31:24] = byte 4
Bits[23:16] = byte 5
Bits[15:8] = byte 6
Bits[7:0] = byte 7
0x01000012 Module Serial Number ACS9860 parts only RO 0 Bits[31:24] = byte 8
Bits[23:16] = byte 9
Bits[15:8] = byte 10
Bits[7:0] = byte 11
0x01000013 Module Test Date Code RO 0 Bits[31:0] = (Reserved for ACS9860 modules)
0x01000014 Module Product Code RO 0 Bits[31:0] = (Reserved for ACS9860 modules)
0x01000015 Module Revision RO 0 Bits[31:0] = (Reserved for ACS9860 modules)
0x01000020 Stored boot checksum RO - Bits[31:0] = Stored value of boot checksum
0x01000021 Calculated boot checksum RO - Bits[31:0] = Calculated value of boot checksum

System Management Configuration : Boot Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x01004006 Factory Boot Software Version RO 0 Returns 16 character Software Version.
Bits[31:0] = First 4 characters (e.g. 'BR2.' if Software Version = 'BR2.1.1dc2 ')
Notes: Valid in all states (See register 0x01000005).
0x01004007 Factory Boot Software version RO 0 Bits[31:0] = Characters 5 to 8 (e.g. '1.1d' using above example)
Notes: Valid in all states (See register 0x01000005).
0x01004008 Factory Boot Software version RO 0 Bits[31:0] = Characters 9 to 12 (e.g. 'c2 ' using above example)
Notes: Valid in all states (See register 0x01000005).
0x01004009 Factory Boot Software version RO 0 Bits[31:0] = Characters 13 to 16 (e.g. ' ' using above example)
Notes: Valid in all states (See register 0x01000005).
0x0100400A Field Boot Software Version RO 0 Returns 16 character Software Version.
Bits[31:0] = First 4 characters (See Factory Boot Software version)
Notes: Valid in all states (See register 0x01000005).
0x0100400B Field Boot Software version RO 0 Bits[31:0] = Characters 5 to 8 (See Factory Boot Software version)
Notes: Valid in all states (See register 0x01000005).
0x0100400C Field Boot Software version RO 0 Bits[31:0] = Characters 9 to 12 (Factory Boot Software version)
Notes: Valid in all states (See register 0x01000005).
0x0100400D Field Boot Software version RO 0 Bits[31:0] = Characters 13 to 16 (Factory Boot Software version)
Notes: Valid in all states (See register 0x01000005).
0x0100400E Reserved - - Reserved
0x0100400F Device start up mode RW 0 Bits[31:16] = Reserved
Bits[15:8] = Boot select. Valid values
0 = Factory boot (default)
1 = Field Boot
All others reserved
Bits[7:0] = Boot mode. Valid values:
0 = Network boot (not yet supported)
1 = Plug & Play
2 = Product Boot (default)
All others reserved

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Writing to this parameter will cause the default startup configuration held in Flash memory to be updated.
All Flash memory devices have a limited lifetime and should be written to ONLY if the contents require updating.

Semtech does not recommend executing any unnecessary writes to this parameter.
0x01004010 Reserved - - Reserved
0x01004011 Boot reset RW 0 Bits[31:1] = Reserved
Bit[0] = Reset device.
Setting this bit to '1' will force an immediate software reset and reboot of the ToPSync device. This bit is self clearing.

Notes: This register write is valid in BOOT state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004020 Non volatile user programmed MAC address Port 0 (High) RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:00 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004021 Non volatile user programmed MAC address Port 0 (Low) RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:00 Byte 4 = 0xB1, byte 5 = 0x00

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004022 Port 0 DHCP enable / disable RW 0 Bits[31:1] = Reserved
Bit[0] = DHCP enabled. Valid values:
0 DHCP disabled
1 DHCP enabled

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004023 Port 0 DHCP lease period RW 604800 Bits[31:0] = Lease period in seconds

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004024 Port 0 IP address RW 0 Bits[31:0] = IP4 address
e.g. the value 0xC0A87B84 represents the IP4 address 192.168.123.132

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004025 Port 0 Subnet mask RW 0 Bits[31:0] = Subnet mask
e.g. the value 0xFFFFFFC0 represents the subnet 255.255.255.192

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004026 Port 0 Default gateway RW 0 Bits[31:0] = Default gateway
e.g. the value 0xFFFFFF00 represents the default gateway 255.255.255.00

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004027 Network port 0 SGMII configuration RW 0 Bits[31:2] = Reserved
Bit[1:0] = Network port 0 SGMII configuration. Valid values:
Bit[0] = Network port 0 SGMII MAC or PHY mode
0 Network port 0 configured as MAC side of SGMII link
1 Network port 0 configured as PHY side of SGMII link
Bit[1] = Reserved

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004040 Non volatile user programmed MAC address Port 1 (High) RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004041 Non volatile user programmed MAC address Port 1 (Low) RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004042 Port 1 DHCP enable / disable RW 0 Bits[31:1] = Reserved
Bit[0] = DHCP enabled. Valid values:
0 DHCP disabled
1 DHCP enabled

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004043 Port 1 DHCP lease period RW 604800 Bits[31:0] = Lease period in seconds

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004044 Port 1 IP address RW 0 Bits[31:0] = IP4 address
e.g. the value 0xC0A87B84 represents the IP4 address 192.168.123.132

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004045 Port 1 Subnet mask RW 0 Bits[31:0] = Subnet mask
e.g. the value 0xFFFFFFC0 represents the subnet 255.255.255.192

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004046 Port 1 Default gateway RW 0 Bits[31:0] = Default gateway
e.g. the value 0xFFFFFF00 represents the default gateway 255.255.255.00

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004047 Network port 1 SGMII configuration RW 0 Bits[31:2] = Reserved
Bit[1:0] = Network port 1 SGMII configuration. Valid values:
Bit[0] = Network port 1 SGMII MAC or PHY mode
0 Network port 1 configured as MAC side of SGMII link
1 Network port 1 configured as PHY side of SGMII link
Bit[1] = Reserved

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004048 Select which port is active RW 0 Bits[31:16] = Reserved
Bits[15:8] Port 1 enabled.
Bits[7:0] Port 0 enabled. Valid values:
0 Port disabled
1 Port enabled

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x01004049 Port 0 VLAN enable/disable RW 0 Bits[31:1] = Reserved
Bit [0] = Vlan enabled. Valid values:
1 VLAN enabled
0 VLAN disabled

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x0100404A Port 1 VLAN enable/disable RW 0 Bits[31:1] = Reserved
Bit [0] = Vlan enabled. Valid values:
1 VLAN enabled
0 VLAN disabled

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x0100404B Port 0 VLAN tag RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(Point). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x0100404C Port 1 VLAN tag RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x0100404D Reserved - - Reserved
0x01004080 Ethernet self test control RW 0 Bits[31:0] = Configure self test operation. Valid values:
0 Stop
1 Start
2 Busy
All others reserved

Notes: This register is valid in BOOT state only. (See register 0x01000005).
0x01004081 Ethernet self test status RO 0 Bits[31:0] = Test state Valid values:
0 Idle
1 Initialising link test
2 Link test SGMII Port 0
3 Link test SGMII Port 1
4 Initialising Ethernet test
5 Ethernet TxRx test
6 Halt link error (No valid link detected)
7 Stopping
All others reserved
/
Notes: This register is only valid in BOOT state. (See register 0x01000005).
0x01004082 Ethernet self test TX packet count RO 0 Bits[31:16] = Number of test packets received by ToPSync
Bits[15:0] = Number of test packets transmitted by ToPSync

Notes: This register is only valid in BOOT state. (See register 0x01000005).
0x01004083 Ethernet self test RX packet count RO 0 Bits[31:16] = Number of test packets received by ToPSync
Bits[15:0] = Number of test packets transmitted by ToPSync

Notes: This register is only valid in BOOT state. (See register 0x01000005).
0x01004084 Reserved - - Reserved
0x01004085 Reserved - - Reserved
0x01004086 Reserved - - Reserved

System Management Configuration : Initial System Configuration Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x01008000 control interface type RW 0 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:1] = Reserved
Bit[0] = Control interface type. Valid values:
0 UDP
1 SPI
0x01008001 control network interface number RW 0 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:1] = Reserved
Bits[0] = Specifies the network interface that can process ToPSync control packets and generate ToPTrace data. Valid values:
0 - network interface 0
1 - network interface 1
0x01008002 UDP management port RW 2000 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:16] = Reserved
Bits[15:0] = Specifies the UDP port used by the control interface.
0x01008003 Reserved - - Reserved
0x01008004 Reserved - - Reserved
0x01008005 Reserved - - Reserved
0x01008008 control network interface network protocol RW 0 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:1] = Reserved
Bits[0] = Specifies the protocol of network interface that can process ToPSync control packets and generate ToPTrace data. Valid values:
0 - ipv4
1 - ipv6

System Management Configuration : Initial System Configuration Parameters for Port 0

[Back to index | Back to parent block]
Address Name RW Default Description
0x0100C000 Reserved - - Reserved
0x0100C001 Reserved - - Reserved
0x0100C002 Reserved - - Reserved
0x0100C003 Reserved - - Reserved
0x0100C004 Reserved - - Reserved
0x0100C005 Reserved - - Reserved
0x0100C006 Reserved - - Reserved
0x0100C007 Reserved - - Reserved
0x0100C008 Reserved - - Reserved
0x0100C009 Reserved - - Reserved
0x0100C00A Reserved - - Reserved

System Management Configuration : Initial System Configuration Parameters for Port 1

[Back to index | Back to parent block]
Address Name RW Default Description
0x01010000 Reserved - - Reserved
0x01010001 Reserved - - Reserved
0x01010002 Reserved - - Reserved
0x01010003 Reserved - - Reserved
0x01010004 Reserved - - Reserved
0x01010005 Reserved - - Reserved
0x01010006 Reserved - - Reserved
0x01010007 Reserved - - Reserved
0x01010008 Reserved - - Reserved
0x01010009 Reserved - - Reserved
0x0101000A Reserved - - Reserved

System Management Configuration : Initial System Configuration Parameters for PTP

[Back to index | Back to parent block]
Address Name RW Default Description
0x01014000 PTP UDP event port RW 319 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:16] = Reserved
Bit[15:0] = UDP event port
0x01014001 PTP UDP general port RW 320 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:16] = Reserved
Bits[15:0] = UDP general port
0x01014002 PTP IP4 multicast address RW 0xE0000181 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:0] = IP4 Multicast address
0x01014003 IP4 event type-of-service RW 0xB8 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:8] = Reserved
Bits[7:0] = IP4 event type-of-service
0x01014004 PTP IP4 general type-of-service RW 0 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:8] = Reserved
Bits[7:0] = IP4 general type of service
0x01014005 PTP Ethernet ethertype RW 0x88F7 To set this parameter, it must be set when the system is in initialising system state.
Bits[31:16] = Reserved
Bits[15:0] = Ethertype for Ethernet PTP messages
0x01014006 PTP ethernet multicast address bytes 0-3 RW 0x011B1900 To set this parameter, it must be set when the system is in initialising system state.
Ethernet Address:
Bits[31:24] = Ethernet address byte 0
Bits[23:16] = Ethernet address byte 1
Bits[15:8] = Ethernet address byte 2
Bits[7:0] = Ethernet address byte 3
0x01014007 PTP ethernet multicast address bytes 4=5 RW 0 To set this parameter, it must be set when the system is in initialising system state.
Ethernet Address:
Bits[31:24] = Ethernet address byte 4
Bits[23:16] = Ethernet address byte 5
Bit[15:0] = Reserved

System Management Configuration : System Configuration Parameters for PTP Delay Measurement and Error Counter

[Back to index | Back to parent block]
Address Name RW Default Description
0x01018000 Enable printing out delay measurement result PTP PLL1 RW 0 Bits[31:1] = Reserved
Bit[0] = 1 - enabled, 0 - not enabled
0x01018001 Get delay measurement state PTP PLL1 RO - Bits[31:0] = 32-bit unsigned integer state value. Valid values:
0 = noSelectedSource.
1 = no1HzInputDetected.
2 = calibratingTo1HzInput.
3 = sourceDataNotValid.
4 = masterInvisible.
5 = masterInvalid.
6 = masterValidating.
7 = masterTooFewTimingMessages.
8 = masterNotOfInterest.
9 = masterRequestingContract.
10 = aligningTo1Hz.
11 = notPrinting.
12 = printingDelays.
Other = reserved.
0x01018002 Enable PTP phase error counter PTP PLL1 RW 0 Bits[31:1] = Reserved
Bit[0] = 1 - enabled, 0 - not enabled
0x01018003 Specify Reference Clock ID for PTP PLL1 RW 2 Bits[31:2] = reserved
Bits[1:0] = 0 - Input Clock PLL1, 1 - Input Clock PLL2, 2 - No Reference Clock Specified
Notes: When no reference clock is specified, the device will automatically use the available clock (either Clock PLL1 or Clock PLL2) as reference. The reference clock must be 1pps clock.
0x01018004 Get the phase difference of PTP PLL1 against Reference Clock RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (PTP PLL1 - Reference Clock).
0x01018005 Get the phase difference of PTP PLL1 against PTP PLL2 RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (PTP PLL1 - PTP PLL2).
0x01018006 Get the phase difference of NodeTime1 against Reference Clock RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (NodeTime1 - Reference Clock).
0x01018007 Get the phase difference of Clock PLL2 against Clock PLL1 RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (Clock PLL2 - Clock PLL1).
0x01018010 Enable printing out delay measurement result PTP PLL2 RW 0 Bits[31:1] = Reserved
Bit[0] = 1 - enabled, 0 - not enabled
0x01018011 Get delay measurement state PTP PLL2 RO - Bits[31:0] = 32-bit unsigned integer state value. Valid values:
0 = noSelectedSource.
1 = no1HzInputDetected.
2 = calibratingTo1HzInput.
3 = sourceDataNotValid.
4 = masterInvisible.
5 = masterInvalid.
6 = masterValidating.
7 = masterTooFewTimingMessages.
8 = masterNotOfInterest.
9 = masterRequestingContract.
10 = aligningTo1Hz.
11 = notPrinting.
12 = printingDelays.
Other = reserved.
0x01018012 Enable PTP phase error counter PTP PLL2 RW 0 Bits[31:1] = Reserved
Bit[0] = 1 - enabled, 0 - not enabled
0x01018013 Specify Reference Clock ID for PTP PLL2 RW 2 Bits[31:2] = reserved
Bits[1:0] = 0 - Input Clock PLL1, 1 - Input Clock PLL2, 2 - No Reference Clock Specified
Notes: When no reference clock is specified, the device will automatically use the available clock (either Clock PLL1 or Clock PLL2) as reference. The reference clock must be 1pps clock.
0x01018014 Get the phase difference of PTP PLL2 against Reference Clock RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (PTP PLL2 - Reference Clock).
0x01018015 Get the phase difference of PTP PLL2 against PTP PLL1 RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (PTP PLL2 - PTP PLL1).
0x01018016 Get the phase difference of NodeTime2 against Reference Clock RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (NodeTime2 - Reference Clock).
0x01018017 Get the phase difference of Clock PLL1 against Clock PLL2 RO - Bits[31:0] = 32-bit float value
Notes: This returns the phase difference of (Clock PLL1 - Clock PLL2).

System Management Configuration : System Configuration Parameters for Binary Lock and Alarm Output pins

[Back to index | Back to parent block]
Address Name RW Default Description
0x0101C001 config for binary lock and alarm pins RW 0x4 Bits[31:3] = Reserved
Bits[2:2] = 0 - alarm active drive enable off
1 - alarm active drive enable on
Bits[1:1] = 0 - alarm polarity, pin is high when an enabled alarm is active and low when all enabled alarms are inactive,
1 - alarm polarity, pin is low when an enabled alarm is active and high when all enabled alarms are inactive
Bits[0:0] = 0 - binary lock pin is high when binary lock is high (ie no binary lock alarms active) and low when binary lock is low (a binary lock low alarm is active)
1 - binary lock pin is high when binary lock is low (ie a binary lock alarm is active) and low when binary lock is high (ie no binary lock alarms active)

System Management Configuration : External voltage controlled oscillator control

[Back to index | Back to parent block]
Address Name RW Default Description
0x01020000 Select PLL to control VCXO RW 6 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1 (see notes)
011 (3) PTP PLL 2 (see notes)
100 (4) NODE PLL 1
101 (5) NODE PLL 1
110 (6) VCXO control is disabled

Notes: This is a one-shot setup of the device. To configure the minimum and maximum DAC levels use register 0x01020002 and to configure the update frequency of the VCXO use register 0x01020001.

Notes: If the PLL is to be driven by the node time then the register 0x27004009 must first be configured with the source that is to drive node time. The node time will not select any other source other than this one until the VCXO has finished calibrating. Once calibration has finished the node time source selection will operate as normal.
0x01020001 Set the minumum VCXO update period in milliseconds RW 100 Bits[31:0] Unsigned 32-bit integer representing the minimum update period (meaning maximum update frequency) for the VCXO in milliseconds

Notes: When VCXO control has not been enabled using register 0x01020000 this register will read back zero. The default minimum update period when VCXO control is active is 100ms (10Hz). If the minimum update period is to be set, it should be set immediately after VCXO control is enabled.
0x01020002 Set DAC minimum and maximum levels RW 0xFFFF0000 Bits[31:16] An unsigned 16-bit integer expressing the maximum DAC level. DAC is 16 bits wide.
Bits[15:0] An unsigned 16-bit integer expressing the minimum DAC level. DAC is 16 bits wide.

By default the DAC value can range from 0 to 65,535, which will correspond to voltage outputs at DACOUT of
DACNEG volts to DACPOS volts. Should the voltage range output by the DAC need to be restricted these registers
can be used to accomplish this.

Notes: This register must be set before register 0x01020000 is written if
the DAC levels are to be applied.
0x01020003 Read the Hardware frequency Integer Unit (HIU) resulting from VCXO auto-calibration RO n/a Bits[31:0] HIU expressed as a single precision floating point number.

Notes: If the VCXO has not been calibrated or is not being used then the register returns 0.0

System Management Configuration : Control interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x01024000 control register for control interface RW 0 Bits[31:2] = Reserved
Bits[1:0] = control register for debug over network interface
0 - disable control network interface
1 - enable control network interface
2 - change control network interface. This option disables the existing configuration and setups the
configuration from the control registers.
0x0102400A physical network interface for control configuration RW 0 Bits[31:1] = Reserved
Bits[0:0] = physical network interface used for control configuration.
0 - network interface 0
1 - network interface 1
0x0102400B virtual network interface for control configuration RW 0 Bits[31:3] = Reserved
Bits[2:0] = virtual network interface used for control configuration.
0x0102400C multi home index for control network interface configuration RW 0 Bits[31:4] = Reserved
Bits[3:0] = multi home index used for control configuration.
0x0102400D network protocol for control configuration RW 0 Bits[31:1] = Reserved
Bits[0:0] = network protocol used for control configuration.
0 - udp over ipv4
1 - udp over ipv6
0x0102400E udp port for control interface configuration RW 2000 Bits[31:16] = Reserved
Bits[15:0] = UDP port used for control configuration.
0x01024013 control interface status RW 0 Bits[31:2] = Reserved
Bits[1:0] = network control interface status
0 - control network interface disabled
1 - control network interface enabled
0x01024014 physical network interface for control status RO 0 Bits[31:1] = Reserved
Bits[0:0] = network interface used for control status.
0 - physical network interface 0
1 - physical network interface 1
0x01024015 virtual network interface for control status RO 0 Bits[31:3] = Reserved
Bits[2:0] = virtual network interface used for control status.
0x01024016 multi home index for control network interface status RO 0 Bits[31:4] = Reserved
Bits[3:0] = multi home index used for control status.
0x01024017 network protocol for control status RO 0 Bits[31:1] = Reserved
Bits[0:0] = network protocol used for control status.
0 - udp over ipv4
1 - udp over ipv6
0x01024018 udp port for control interface status RO 2000 Bits[31:16] = Reserved
Bits[15:0] = UDP port used for control messages status.

System Management Configuration : Plug & Play Configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x0102C000 Select parameters to save to startup config RW 0 Bitmask to select which parameters are to be stored within the Plug & Play profile.
Notes: Clearing a bit to 0 will add the selected parameters to the profile. Setting the bit to 1 will remove it from the profile. Valid configuration options:
Bit[0] = Pre-run system configuration (Initialising system state parameters)
Bit[1] = Reserved: Post-run system configuration (Running state parameters)
Bit[2] = VLAN configuration network interface 0 (00)
Bit[3] = VLAN configuration network interface 1 (1/0)
Bit[4] = Network interface 0 (0/0) configured
Bit[5] = Network interface 1 (1/0) configured
Bit[6] = IPv4 configuration network interface 0 (0/0)
Bit[7] = IPv4 configuration network interface 1 (1/0)
Bit[8] = IPv6 configuration network interface 0 (0/0)
Bit[9] = IPv6 configuration network interface 1 (1/0)
Bit[10] = Control interface configuration
Bits[31:11] = Reserved
/
Warning: Depending on the network configuration of ToPPsync prior to issuing this command ToPSync may fail to respond to subsequent UDP control commands after rebooting.
In this event the user may use the SPI control interface to configure the device.
0x0102C001 Save running config to start up config RW 0 Bits[0:0] = Configuration Profile Destination
1 = Save running configuration to start up configuration
0x0102C002 Restore Running Config RW 0 Bits[0:0] = write 1 to restore saved config to running config

Notes: This register write is valid in INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).
0x0102C003 PnP Profile Status RO 0 Bits[31:0] = Operation status
0 = Profile disabled
1 = Profile active

All other values reserved
0x0102C004 PnP Profile Error RO 0 Bits[31:0] = Error code
0 = Profile checksum ok
1 = Profile checksum error
2 = Profile not initialised

All other values reserved
0x0102C020 Activate the restart protocol RW 0x0 Bits[31:1] = Reserved
Bits[0:0] = 0 - Restart protocol is not activated
1 - Restart protocol is activated
Notes: This register write is valid only in INITIALISING_SYSTEM state over SPI. Setting this in any other state will not alter whether the protocol is activated or deactivated.
Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x0102C021 Restart protocol current state RO 0x0 Bits[31:2] = Reserved
Bits[1:0] = 0 - Restart protocol is waiting for response from management server
1 - Restart protocol has received response from management server
2 - Restart protocol has timed out waiting for management server

Notes: This register is valid only in INITIALISING_SYSTEM state over SPI.
0x0102C030 Configure network firmware support RW 0 Bits[31:1] = Reserved
Bit[0] = Configure network firmware upgrade support
0 = Disabled
1 = Enabled

Notes: This register write is valid in BOOT or INITIALISING_SYSTEM state only. Register read is valid in all states (See register 0x01000005).

Warning: Semtech does not recommend executing any unnecessary writes to this parameter. (See register 0x0100400F)
0x0102C040 Reserved - - Reserved
0x0102C041 Reserved - - Reserved
0x0102C042 Reserved - - Reserved
0x0102C043 Reserved - - Reserved
0x0102C044 Reserved - - Reserved
0x0102C045 Reserved - - Reserved
0x0102C046 Reserved - - Reserved
0x0102C047 Reserved - - Reserved
0x0102C048 Reserved - - Reserved
0x0102C049 Reserved - - Reserved
0x0102C04A Reserved - - Reserved
0x0102C04B Reserved - - Reserved
0x0102C04C Reserved - - Reserved
0x0102C04D Reserved - - Reserved
0x0102C04E Reserved - - Reserved
0x0102C04F Reserved - - Reserved
0x0102C050 Reserved - - Reserved
0x0102C051 Reserved - - Reserved
0x0102C080 Reserved - - Reserved

System Management Configuration : ptp 8265.1 & 8275.1 profile configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x01030000 configer ptp running in 8275.1 or 8265.1 profile RW 0x0 Bits[31:2] = Reserved
Bits[1:0] = 1 - run under 8275.1 profile, when setting this register,
ACS9522 will set the ptp port default value according 8275.1 profile.
2 - run under 8265.1 profile, when setting this register,
ACS9522 will set the ptp port default value according 8265.1 profile.

Clock Inputs Configuration : Sub Blocks

[Back to index]
Start Address Description
0x02000000 Clock input configuration

Clock Inputs Configuration : Clock input configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x02000000 Mux between SETS and package pins for input clocks RW 0x0 Bits[0:0] = '0' means package pin IPCLK0 is the selected frequency source
'1' means SETS output 01 is the selected frequency source
Bits[1:1] = '0' means package pin IPCLK1 is the selected frequency source
'1' means SETS output 02 is the selected frequency source
Bits[2:2] = '0' means package pin IPCLK2 is the selected frequency source
'1' means SETS output 04 is the selected frequency source
Bits[3:3] = '0' means package pin IPCLK3 is the selected frequency source
'1' means SETS output 05 is the selected frequency source
0x02000001 Frequency in Hertz from MUX 0 RW 0x0 Bits[31:0] = Frequency in Hertz of clock input. If the clock is enabled & selected on any clock PLL this
setting is applied immediately. The mux block for the input clock specifies whether the input
comes from a package pin or is routed internal within the ToPSync package from one of the SETS
outputs. The mux options must be set separately in register 0x02000000.
0x02000002 Frequency in Hertz from MUX 1 RW 0x0 Bits[31:0] = Frequency in Hertz of clock input. If the clock is enabled & selected on any clock PLL this
setting is applied immediately. The mux block for the input clock specifies whether the input
comes from a package pin or is routed internal within the ToPSync package from one of the SETS
outputs. The mux options must be set separately in register 0x02000000.
0x02000003 Frequency in Hertz from MUX 2 RW 0x0 Bits[31:0] = Frequency in Hertz of clock input. If the clock is enabled & selected on any clock PLL this
setting is applied immediately. The mux block for the input clock specifies whether the input
comes from a package pin or is routed internal within the ToPSync package from one of the SETS
outputs. The mux options must be set separately in register 0x02000000.
0x02000004 Frequency in Hertz from MUX 3 RW 0x0 Bits[31:0] = Frequency in Hertz of clock input. If the clock is enabled & selected on any clock PLL this
setting is applied immediately. The mux block for the input clock specifies whether the input
comes from a package pin or is routed internal within the ToPSync package from one of the SETS
outputs. The mux options must be set separately in register 0x02000000.
0x02000005 Frequency in Hertz of reference source 4 RW IPCLK 0|1 = 0x1; 0x0 otherwise. Bits[31:0] = Frequency in Hertz of clock input.

Notes: If the clock is enabled & selected on any clock PLL this setting is applied immediately. These inputs can only come from the corresponding package pins.
0x02000006 Frequency in Hertz of reference source 5 RW IPCLK 0|1 = 0x1; 0x0 otherwise. Bits[31:0] = Frequency in Hertz of clock input.

Notes: If the clock is enabled & selected on any clock PLL this setting is applied immediately. These inputs can only come from the corresponding package pins.
0x02000007 Frequency in Hertz of reference source 6 RW IPCLK 0|1 = 0x1; 0x0 otherwise. Bits[31:0] = Frequency in Hertz of clock input.

Notes: If the clock is enabled & selected on any clock PLL this setting is applied immediately. These inputs can only come from the corresponding package pins.
0x02000008 Frequency in Hertz of reference source 7 RW IPCLK 0|1 = 0x1; 0x0 otherwise. Bits[31:0] = Frequency in Hertz of clock input.

Notes: If the clock is enabled & selected on any clock PLL this setting is applied immediately. These inputs can only come from the corresponding package pins.

Clock Outputs Configuration : Sub Blocks

[Back to index]
Start Address Description
0x03000000 Frequency Parameters
0x03004000 PPS Parameters
0x03008000 Phase Aligned Parameters
0x03010000 Multiplexor Parameters

Clock Outputs Configuration : Frequency Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x03000000 DDS Clock 0 RW 0 Bits[31:0] = Frequency in Hz
Notes: This frequency must be chosen so that it conforms to the range of permitted configurable frequencies (see ToPSync data sheet). Values less than 1000Hz, except 1Hz, or greater than 62.5 MHz are invalid and will be rejected with an out-of-range error.
0x03000001 DDS Clock 1 RW 0 Bits[31:0] = Frequency in Hz
Notes: This frequency must be chosen so that it conforms to the range of permitted configurable frequencies (see ToPSync data sheet). Values less than 1000Hz, except 1Hz, or greater than 62.5 MHz are invalid and will be rejected with an out-of-range error.
0x03000002 DDS Clock 2 RW 0 Bits[31:0] = Frequency in Hz
Notes: This frequency must be chosen so that it conforms to the range of permitted configurable frequencies (see ToPSync data sheet). Values less than 1000Hz, except 1Hz, or greater than 62.5 MHz are invalid and will be rejected with an out-of-range error.
0x03000003 DDS Clock 3 RW 0 Bits[31:0] = Frequency in Hz
Notes: This frequency must be chosen so that it conforms to the range of permitted configurable frequencies (see ToPSync data sheet). Values less than 1000Hz, except 1Hz, or greater than 62.5 MHz are invalid and will be rejected with an out-of-range error.
0x03000020 Enable/Disable DDS Clocks RW 0 Bits[31:4] = Reserved
Bit[3] = DDS Clock 3 Enable (0=disable, 1 = enable)
Bit[2] = DDS Clock 2 Enable (0=disable, 1 = enable)
Bit[1] = DDS Clock 1 Enable (0=disable, 1 = enable)
Bit[0] = DDS Clock 0 Enable (0=disable, 1 = enable)
0x03000040 Select source for DDS (Frequency) output 0 RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x03000041 Select source for DDS (Frequency) output 1 RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x03000042 Select source for DDS (Frequency) output 2 RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x03000043 Select source for DDS (Frequency) output 3 RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2

Clock Outputs Configuration : PPS Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x03004000 PPS Enable/Disable RW 3 Bits[31:2] = Reserved
Bit[1] = Enable PPS 1 (0=disable, 1 = enable)
Bit[0] = Enable PPS 0 (0=disable, 1 = enable)
Notes: Disabling PPSn output also disables the corresponding phase clock, overriding
registers 0x03010000 and
0x03010001
0x03004020 PPS0 Output Period RW 1 Bits[31:8] = Reserved
Bits[7:0] = Output periods in seconds
0x03004021 PPS1 Output Period RW 1 Bits[31:8] = Reserved
Bits[7:0] = Output periods in seconds
0x03004040 Clock PLL1 PPS Pulse Width RW 0 Bits[31:8] = Width of 1PPS pulse ‘high’ period in nanoseconds generated by the Clock PLL1 (max 400ms).
The default value 0xF4240 specifies a 1ms high period.
Notes: Bits 0 to 2 will be set to zero. This is because of the 8ns resolution of
the internal clock. These bits are ignored on writes
The actual PPS output that this pulse width affects is determined by the PPS0/1 and PhaseClk0/1 source select api
0x03004041 Clock PLL2 PPS Pulse Width RW 0xF4240 Bits[31:8] = Width of 1PPS pulse ‘high’ period in nanoseconds generated by the Clock PLL2 (max 400ms).
The default value 0xF4240 specifies a 1ms high period.
Notes: Bits 0 to 2 will be set to zero. This is because of the 8ns resolution of
the internal clock. These bits are ignored on writes
The actual PPS output that this pulse width affects is determined by the PPS0/1 and PhaseClk0/1 source select api
0x03004042 PTP PLL1 PPS Pulse Width RW 0xF4240 Bits[31:8] = Width of 1PPS pulse ‘high’ period in nanoseconds generated by the PTP PLL1 (max 400ms).
The default value 0xF4240 specifies a 1ms high period.
Notes: Bits 0 to 2 will be set to zero. This is because of the 8ns resolution of
the internal clock. These bits are ignored on writes
The actual PPS output that this pulse width affects is determined by the PPS0/1 and PhaseClk0/1 source select api
0x03004043 PTP PLL2 PPS Pulse Width RW 0xF4240 Bits[31:8] = Width of 1PPS pulse ‘high’ period in nanoseconds generated by the PTP1 PLL (max 400ms).
The default value 0xF4240 specifies a 1ms high period.
Notes: Bits 0 to 2 will be set to zero. This is because of the 8ns resolution of
the internal clock. These bits are ignored on writes
The actual PPS output that this pulse width affects is determined by the PPS0/1 and PhaseClk0/1 source select api
0x03004044 NODE PLL1 PPS Pulse Width RW 0xF4240 Bits[31:8] = Width of 1PPS pulse ‘high’ period in nanoseconds generated by the NODE PLL1 (max 400ms).
The default value 0xF4240 specifies a 1ms high period.
Notes: Bits 0 to 2 will be set to zero. This is because of the 8ns resolution of
the internal clock. These bits are ignored on writes
The actual PPS output that this pulse width affects is determined by the PPS0/1 and PhaseClk0/1 source select api
0x03004045 NODE PLL2 PPS Pulse Width RW 0xF4240 Bits[31:8] = Width of 1PPS pulse ‘high’ period in nanoseconds generated by the NODE PLL2 (max 400ms).
The default value 0xF4240 specifies a 1ms high period.
Notes: Bits 0 to 2 will be set to zero. This is because of the 8ns resolution of
the internal clock. These bits are ignored on writes
The actual PPS output that this pulse width affects is determined by the PPS0/1 and PhaseClk0/1 source select api

Clock Outputs Configuration : Phase Aligned Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x03008000 Freq divisor for ClockPLL1 phase aligned output RW 0x18 Bits[31] Sets the phase aligned freq to 10MHz (special case not available using divisor below)
If this bit is set all other bits in the register will be forced to 0
Bits[30:26] Not used - read as zero
Bits[26:0] Divisor used to compute the output clock frequency. Default value is 0x18 (5 Mhz)
Output frequency is configured according to the following equation:
Output frequency = 125e06 /(divider + 1).
Example: To output a 5 Mhz clock, the divider must be set to 24, so that: 125e06 /(24 + 1) = 5 Mhz
0x03008001 Freq divisor for Clock PLL2 phase aligned output RW 0x18 Bits[31:0] Same as "Freq divisor for ClockPLL1 phase aligned output"
0x03008002 Freq divisor for PTP PLL 1 phase aligned output RW 0x18 Bits[31:0] Same as "Freq divisor for ClockPLL1 phase aligned output"
0x03008003 Freq divisor for PTP PLL 2 phase aligned output RW 0x18 Bits[31:0] Same as "Freq divisor for ClockPLL1 phase aligned output"
0x03008004 Freq divisor for Node PLL 1 phase aligned output RW 0x18 Bits[31:0] Same as "Freq divisor for ClockPLL1 phase aligned output"
0x03008005 Freq divisor for Node PLL 2 phase aligned output RW 0x18 Bits[31:0] Same as "Freq divisor for ClockPLL1 phase aligned output"

Clock Outputs Configuration : Multiplexor Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x03010000 PPS0 and PhaseClk0 source select RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 1
0x03010001 PPS1 and PhaseClk1 source select RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x03010002 PhaseClk2 source select RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x03010003 PhaseClk3 source select RW 4 Bits[31:4] = Reserved
Bits[3:0] = Source
Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x03010020 PTP block output 0 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) ToPSync output driven by DDS Freq0 (see 0x03000000)
001 (1) ToPSync output driven by PhaseClk0 (see 0x03010000)
010 (2) ToPSync output driven by PhaseClk1 (see 0x03010001)
011 (3) ToPSync output driven by PhaseClk2 (see 0x03010002)
100 (4) ToPSync output driven by PhaseClk3 (see 0x03010003)
0x03010021 PTP block output 1 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) ToPSync output driven by DDS Freq1 (see 0x03000001)
001 (1) ToPSync output driven by PhaseClk0 (see 0x03010000)
010 (2) ToPSync output driven by PhaseClk1 (see 0x03010001)
011 (3) ToPSync output driven by PhaseClk2 (see 0x03010002)
100 (4) ToPSync output driven by PhaseClk3 (see 0x03010003)
0x03010022 PTP block output 2 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) ToPSync output driven by DDS Freq2 (see 0x03000002)
001 (1) ToPSync output driven by PhaseClk0 (see 0x03010000)
010 (2) ToPSync output driven by PhaseClk1 (see 0x03010001)
011 (3) ToPSync output driven by PhaseClk2 (see 0x03010002)
100 (4) ToPSync output driven by PhaseClk3 (see 0x03010003)
0x03010023 PTP block output 3 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) ToPSync output driven by DDS Freq3 (see 0x03000003)
001 (1) ToPSync output driven by PhaseClk0 (see 0x03010000)
010 (2) ToPSync output driven by PhaseClk1 (see 0x03010001)
011 (3) ToPSync output driven by PhaseClk2 (see 0x03010002)
100 (4) ToPSync output driven by PhaseClk3 (see 0x03010003)
0x03010040 Package pin OpClk0 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) Package pin OpClk0 driven by SETS output 1
001 (1) Package pin OpClk0 driven by TopSync output 0 (see 0x03010020)
0x03010041 Package pin OpClk1 source select RW 1 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) Package pin OpClk0 driven by SETS output 2
001 (1) Package pin OpClk0 driven by TopSync output 1 (see 0x03010021)
0x03010042 Package pin OpClk2 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) Package pin OpClk0 driven by SETS output 4
001 (1) Package pin OpClk0 driven by TopSync output 2 (see 0x03010022)
0x03010043 Package pin OpClk3 source select RW 0 Bits[31:4] = Reserved
Bits[3:0] = Output Source
Valid bit (decimal) values:
000 (0) Package pin OpClk0 driven by SETS output 5
001 (1) Package pin OpClk0 driven by PTP block output 3 (see 0x03010023)

Network Interface 1 Configuration (physical port 0, virtual port 0) : Sub Blocks

[Back to index]
Start Address Description
0x04000000 Network Interface Parameters for network interface
0x04004000 Network Interface Parameters for Ethernet
0x04008000 Network Interface Parameters for Ethernet Statistics
0x0400C000 Network Interface Parameters for VLAN
0x04010000 Network Interface Parameters for MDIO
0x04014000 Network Interface Parameters for PCS
0x04018000 Network Interface Parameters for IP4
0x0401C000 Network Interface Parameters for IP4 Statistics
0x04020000 Network Interface Parameters for IP4 status
0x04040000 Network Interface Parameters for ARP entry configuration
0x04044000 Network Interface Parameters for ARP table
0x04080000 Network Interface Parameters for IP6 address configuration
0x04084000 Network Interface Parameters for IP6 address status

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x04000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.
0x04000001 network interface DOS protection active time RO 0 Bits[31:0] = time that DOS protection has been active on the network interface in clock ticks. Reading this register will cause
it to be reset to 0.
0x04000002 network interface DOS protection active incidents RO 0 Bits[31:0] = number of active incidents that have been detected on the network interface

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for Ethernet

[Back to index | Back to parent block]
Address Name RW Default Description
0x04004000 ethernet address bytes 0-3 RO 1 Ethernet Address comprise of 6 bytes [0,1,2,3,4,5].
Bits[31:24] = Ethernet address byte 0
Bits[23:16] = Ethernet address byte 1
Bits[15:8] = Ethernet address byte 2
Bits[7:0] = Ethernet address byte 3
0x04004001 ethernet address bytes 4-5 RO 1 Bits[31:24] = Ethernet address byte 4
Bits[23:16] = Ethernet address byte 5
Bit[15:0] = Reserved
0x04004002 Reserved - - Reserved
0x04004003 Reserved - - Reserved

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for Ethernet Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x04008000 received Ethernet packets RO 0 Bits[31:0] = Number of received Ethernet packets
0x04008001 received Ethernet missed packets RO 0 Bits[31:0] = Number of missed received Ethernet packets
0x04008002 received Ethernet discarded packets RO 0 Bits[31:0] = Number of discarded received Ethernet packets
0x04008003 received Ethernet packets with errors RO 0 Bits[31:0] = Number of received Ethernet packets with errors
0x04008004 received Ethernet packets with crc errors RO 0 Bits[31:0] = Number of received Ethernet packets with CRC errors
0x04008005 transmitted Ethernet packets RO 0 Bits[31:0] = Number of transmitted Ethernet packets
0x04008006 transmitted Ethernet missed packets RO 0 Bits[31:0] = Number of transmitted Ethernet packets that were missed
0x04008007 transmitted Ethernet discarded packets RO 0 Bits[31:0] = Number of discarded transmitted Ethernet packets
0x04008008 transmitted Ethernet packets with errors RO 0 Bits[31:0] = Number of transmitted Ethernet packets with errors
0x04008009 Reserved - - Reserved
0x0400800A Reserved - - Reserved
0x0400800B Reserved - - Reserved
0x0400800C Reserved - - Reserved
0x0400800D Reserved - - Reserved
0x0400800E Reserved - - Reserved
0x0400800F Reserved - - Reserved
0x04008010 Reserved - - Reserved
0x04008011 Reserved - - Reserved
0x04008012 Reserved - - Reserved
0x04008013 Reserved - - Reserved
0x04008014 Reserved - - Reserved

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x0400C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x0400C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x0400C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x0400C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for MDIO

[Back to index | Back to parent block]
Address Name RW Default Description
0x04010000 MDIO control RO 0 Bits[31:1] = Reserved
Bits[0:0] = MDIO available. Valid values:
0 MDIO not available
1 MDIO available
0x04010001 Reserved - - Reserved
0x04010002 Reserved - - Reserved
0x04010003 Reserved - - Reserved

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for PCS

[Back to index | Back to parent block]
Address Name RW Default Description
0x04014000 SGMII configuration RO 0 Bits[31:2] = Reserved
Bits[1] = SGMII mode. Valid values:
0 SGMII is in PHY mode
1 SGMII is in MAC mode
Bit[0] = MII mode. Valid values:
0 MII mode
1 SGMII mode
0x04014001 PCS control register RW 0x00001140 Bits[31:16] = Reserved
Bit [15] = PCS Reset. Valid Values:
0 Normal operation
1 Generate a synchronous reset pulse to reset SGMII core (Self-Clearing)
Bit [14] = Loopback. Valid Values:
0 Normal operation
1 Serial loopback is implemented in SGMII Core
Bit [13] = Reserved
Bit [12] = Auto Negotiation Enable. Valid Values:
0 Auto Negotiation disabled
1 Auto Negotiation enabled (default reset value)
Bits[11:10] = Reserved
Bit [9] = Restart Auto Negotiation. Valid Values:
0 Normal operation
1 Restart an Auto Negotiation sequence. (Self-Clearing)
Bits[8:0] = Reserved
0x04014002 PCS status register RO 0 Bits[31:0] = As defined in IEEE 802.3-2012 Clause 22.2.4.2
0x04014003 PCS device ability register RO 0 These are all Read only bits, used by the SGMII PHY to advertise various capabilities
Bits[31:16] = Reserved
Bit [15] = Copper Link Status. Valid Values:
0 Copper interface link is down
1 Copper interface link is up
Bit [14] = Acknowledgement bit used during autonegotiation.
Setting of the bit in the device ability advertisement register is not relevant to the
operation of the autonegotiation function. The bit is typically set in the received partner
ability register upon successful completion of autonegotiation.
Bit [13] = Reserved
Bit [12] = Copper Duplex Status. Valid Values:
0 Copper Interface resolved to Half-Duplex
1 Copper Interface resolved to Full-Duplex
Bits[11:10] = Copper Speed. Valid Values:
00 Copper Interface Speed is 10Mbps
01 Copper Interface Speed is 100Mbps
10 Copper Interface Speed is Gigabit
11 Reserved
Bits[9:0] = Reserved
0x04014004 PCS partner ability register RO 0 These are all Read only bits, used by the SGMII PHY to advertise various capabilities
Bits[31:16] = Reserved
Bit [15] = Copper Link Status. Valid Values:
0 Copper interface link is down
1 Copper interface link is up
Bit [14] = Acknowledgement bit used during autonegotiation.
Setting of the bit in the device ability advertisement register is not relevant to the
operation of the autonegotiation function. The bit is typically set in the received partner
ability register upon successful completion of autonegotiation.
Bit [13] = Reserved
Bit [12] = Copper Duplex Status. Valid Values:
0 Copper Interface resolved to Half-Duplex
1 Copper Interface resolved to Full-Duplex
Bits[11:10] = Copper Speed. Valid Values:
00 Copper Interface Speed is 10Mbps
01 Copper Interface Speed is 100Mbps
10 Copper Interface Speed is Gigabit
11 Reserved
Bits[9:0] = Reserved
0x04014005 PCS interface mode register RO 0 Bits[31:0] = Reserved
0x04014006 SERDES control register RO 0 Bits[31:0] = Reserved
0x04014007 SERDES status register RO 0 Bits[31:0] = Reserved
0x04014008 SGMII lock value RO 0 Bits[31:0] = SGMII Reference Clock Frequency – indicates the relative frequency offset between
the local SGMII reference clock and the ToPSync REFCLK input.
The value indicates the offset in steps of 0.3 ppm, with a value of 0x00320000 indicating perfect alignment.
For reliable operation the value should be between 0x0031FEA2 and 0x0032015E.
An out of range value could indicate a missing local SGMII reference clock.

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x04018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x04018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x04018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x04018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x04018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x04018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x04018010 IP4 address multi-home index 1 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 1 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04018011 IP4 address multi-home index 1 RW 0 Bits[31:0] = IP4 address to be configured multi-home index 1.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x04018012 IP4 subnet mask multi-home index 1 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 1.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x04018020 IPv4 address multi-home index 2 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 2 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04018021 IP4 address multi-home index 2 RW 0 Bits[31:0] = IP4 address multi-home index 2.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x04018022 IP4 subnet mask multi-home index 2 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 2.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x04018030 IPv4 address multi-home index 3 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = ip4 address multi-home index 3 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04018031 IP4 address multi-home index 3 RW 0 Bits[31:0] = IP4 address multi-home index 3.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x04018032 IP4 subnet mask multi-home index 3 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 3.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x04018040 IPv4 address multi-home index 4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04018041 IP4 address multi-home index 4 RW 0 Bits[31:0] = IP4 address multi-home index 4.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x04018042 IP4 subnet mask multi-home index 4 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 4.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x04018050 IPv4 address multi-home index 5 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 5 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04018051 IP4 address multi-home index 5 RW 0 Bits[31:0] = IP4 address multi-home index 5.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x04018052 IP4 subnet mask multi-home index 5 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 5.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x0401C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x0401C001 Reserved - - Reserved
0x0401C002 Reserved - - Reserved
0x0401C003 Reserved - - Reserved
0x0401C004 Reserved - - Reserved
0x0401C005 Reserved - - Reserved
0x0401C006 Reserved - - Reserved
0x0401C007 Reserved - - Reserved
0x0401C008 Reserved - - Reserved
0x0401C009 Reserved - - Reserved
0x0401C00A Reserved - - Reserved
0x0401C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x0401C00C Reserved - - Reserved
0x0401C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x0401C00E Reserved - - Reserved
0x0401C00F Reserved - - Reserved
0x0401C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x0401C011 Reserved - - Reserved
0x0401C012 Reserved - - Reserved
0x0401C013 Reserved - - Reserved
0x0401C014 Reserved - - Reserved
0x0401C015 Reserved - - Reserved
0x0401C016 Reserved - - Reserved
0x0401C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x0401C018 Reserved - - Reserved
0x0401C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x0401C01A Reserved - - Reserved
0x0401C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x0401C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x04020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x04020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x04020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x04020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x04020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x04020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x04020010 IP4 address multi-home index 1 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 1 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x04020011 IP4 address multi-home index 1 RO 0 Bits[31:0] = IP4 address multi-home index 1
0x04020012 IP4 subnet mask multi-home index 1 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 1
0x04020020 IP4 address multi-home index 2 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 2 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x04020021 IP4 address multi-home index 2 RO 0 Bits[31:0] = IP4 address
0x04020022 IP4 subnet mask multi-home index 2 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 2
0x04020030 ip4 address multi-home index 3 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 3 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x04020031 IP4 address multi-home index 3 RO 0 Bits[31:0] = IP4 address multi-home index 3
0x04020032 IP4 subnet mask multi-home index 3 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 3
0x04020040 IP4 address multi-home index 4 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 4 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x04020041 IP4 address multi-home index 4 RO 0 Bits[31:0] = IP4 address multi-home index 4
0x04020042 IP4 subnet mask multi-home index 4 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 4
0x04020050 IP4 address multi-home index 5 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 5 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x04020051 IP4 address multi-home index 5 RO 0 Bits[31:0] = IP4 address multi-home index 5
0x04020052 IP4 subnet mask multi-home index 5 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 5

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x04040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x04040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x04040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x04040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x04040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x04040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x04040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x04044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x04044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x04044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x04044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x04044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x04044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x04044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x04044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x04044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x04044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0404401A Reserved - - Reserved
0x0404401B Reserved - - Reserved
0x04044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x04044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x04044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x04044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x04044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x04044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x04044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0404402A Reserved - - Reserved
0x0404402B Reserved - - Reserved
0x04044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x04044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x04044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x04044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x04044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x04044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x04044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0404403A Reserved - - Reserved
0x0404403B Reserved - - Reserved
0x04044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x04044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x04044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x04044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x04044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x04044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x04044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0404404A Reserved - - Reserved
0x0404404B Reserved - - Reserved
0x04044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x04044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x04044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x04044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x04044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x04044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x04044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0404405A Reserved - - Reserved
0x0404405B Reserved - - Reserved
0x04044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x04044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x04044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x04044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x04044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x04044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x04044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x04044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x04044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x04044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x04044FF3 Reserved - - Reserved
0x04044FF4 Reserved - - Reserved

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x04080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x04080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x04080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x04080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x0408000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x0408000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x04080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080040 configuration control for IP6 address multi-home index 1 RW 1 Bits[31:1] = Reserved
Bit[1:0] = ip6 address multi-home index 1 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04080041 IP6 address multi-home index 1 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080042 IP6 address multi-home index 1 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080043 IP6 address multi-home index 1 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080044 IP6 address multi-home index 1 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080045 IP6 address multi-home index 1 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 1 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080050 IP6 address multi-home index 2 configuration control RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 address multi-home index 2 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04080051 IP6 address multi-home index 2 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080052 IP6 address multi-home index 2 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080053 IP6 address multi-home index 2 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080054 IP6 address multi-home index 2 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080055 IP6 address multi-home index 2 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 2 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080060 IP6 address multi-home index 3 configuration control RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 multi-home index 3 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04080061 IP6 address multi-home index 3 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080062 IP6 address multi-home index 3 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080063 IP6 address multi-home index 3 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080064 IP6 address multi-home index 3 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080065 IP6 address multi-home index 3 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 3 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080070 IP6 address multi-home index 4 configuration control RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 address multi-home index 4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04080071 IP6 address multi-home index 4 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080072 IP6 address multi-home index 4 bytes 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080073 IP6 address multi-home index 4 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080074 IP6 address multi-home index 4 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080075 IP6 address multi-home index 4 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 4 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080080 IP6 address multi-home index 5 prefix length RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 address multi-home index 5 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x04080081 IP6 address multi-home index 5 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080082 IP6 address multi-home index 5 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080083 IP6 address multi-home index 5 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080084 IP6 address multi-home index 5 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x04080085 IP6 address multi-home 5 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 5 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.

Network Interface 1 Configuration (physical port 0, virtual port 0) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x04084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x04084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x04084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x04084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x0408400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x0408400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x04084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x04084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x04084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x04084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x04084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x04084016 Reserved - - Reserved
0x04084017 Reserved - - Reserved
0x04084040 IP6 address multi-home index 1 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 address multi-home index 1 control configuration status. Valid values:
0 IP6 address multi-home index 1 disabled
1 IP6 address multi-home index 1 enabled
0x04084041 IP6 address multi-home index 1 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 0 to 3 status
0x04084042 IP6 address multi-home index 1 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 4 to 7 status
0x04084043 IP6 address multi-home index 1 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 8 to 11 status
0x04084044 IP6 address multi-home index 1 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 12 to 15 status
0x04084045 IP6 address multi-home index 1 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 1 prefix length status
0x04084046 Reserved - - Reserved
0x04084047 Reserved - - Reserved
0x04084050 IP6 address multi-home index 2 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 2 disabled
1 IP6 address multi-home index 2 enabled
0x04084051 IP6 address multi-home index 2 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 0 to 3 status
0x04084052 IP6 address multi-home index 2 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 4 to 7 status
0x04084053 IP6 address multi-home index 2 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 8 to 11 status
0x04084054 IP6 address multi-home index 2 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 12 to 15 status
0x04084055 IP6 address multi-home index 2 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 2 prefix length status
0x04084056 Reserved - - Reserved
0x04084057 Reserved - - Reserved
0x04084060 IP6 address multi-home index 3 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 3 disabled
1 IP6 address multi-home index 3 enabled
0x04084061 IP6 address multi-home index 3 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 0 to 3 status
0x04084062 IP6 address multi-home index 3 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 4 to 7 status
0x04084063 IP6 address multi-home index 3 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 8 to 11 status
0x04084064 IP6 address multi-home index 3 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 12 to 15 status
0x04084065 IP6 address multi-home index 3 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 3 prefix length status
0x04084066 Reserved - - Reserved
0x04084067 Reserved - - Reserved
0x04084070 IP6 address multi-home index 4 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 4 disabled
1 IP6 address multi-home index 4 enabled
0x04084071 IP6 address multi-home index 4 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 0 to 3 of address status
0x04084072 IP6 address multi-home index 4 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 4 to 7 of address status
0x04084073 IP6 address multi-home index 4 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 8 to 11 of address status
0x04084074 IP6 address multi-home index 4 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 12 to 15 of address status
0x04084075 IP6 address multi-home index 4 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 4 prefix length of address status
0x04084076 Reserved - - Reserved
0x04084077 Reserved - - Reserved
0x04084080 IP6 address multi-home index 5 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 5 disabled
1 IP6 address multi-home index 5 enabled
0x04084081 IP6 address multi-home index 5 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 0 to 3 status
0x04084082 IP6 address multi-home index 5 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 4 to 7 status
0x04084083 IP6 address multi-home index 5 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 8 to 11 status
0x04084084 IP6 address multi-home index 5 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 12 to 15 status
0x04084085 IP6 address multi-home index 5 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 5 prefix length status
0x04084086 Reserved - - Reserved
0x04084087 Reserved - - Reserved
0x04084090 Reserved - - Reserved
0x04084091 Reserved - - Reserved
0x04084092 Reserved - - Reserved
0x04084093 Reserved - - Reserved
0x04084094 Reserved - - Reserved
0x04084095 Reserved - - Reserved
0x04084096 Reserved - - Reserved
0x04084097 Reserved - - Reserved
0x040840A0 Reserved - - Reserved
0x040840A1 Reserved - - Reserved
0x040840A2 Reserved - - Reserved
0x040840A3 Reserved - - Reserved
0x040840A4 Reserved - - Reserved
0x040840A5 Reserved - - Reserved
0x040840A6 Reserved - - Reserved
0x040840A7 Reserved - - Reserved
0x040840B0 IP6 address multi-home index 8 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 8 disabled
1 IP6 address multi-home index 8 enabled
0x040840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x040840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x040840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x040840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x040840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x040840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x040840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x040840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x040840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x040840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x040840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x040840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x040840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x040840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x040840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x040840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x040840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x040840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x040840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x040840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x040840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x040840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x040840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x040840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x040840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x040840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x040840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x040840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x040840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x040840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x040840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x040840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x040840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x040840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x040840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x040840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x040840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x040840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x040840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x04084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x04084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x04084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x04084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x04084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x04084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x04084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x04084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x04084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x04084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x04084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x04084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x04084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x04084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x04084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x04084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Network Interface 2 Configuration (physical port 1, virtual port 0) : Sub Blocks

[Back to index]
Start Address Description
0x05000000 Network Interface Parameters for network interface
0x05004000 Network Interface Parameters for Ethernet
0x05008000 Network Interface Parameters for Ethernet Statistics
0x0500C000 Network Interface Parameters for VLAN
0x05014000 Network Interface Parameters for PCS
0x05018000 Network Interface Parameters for IP4
0x0501C000 Network Interface Parameters for IP4 Statistics
0x05020000 Network Interface Parameters for IP4 status
0x05040000 Network Interface Parameters for ARP entry configuration
0x05044000 Network Interface Parameters for ARP table
0x05080000 Network Interface Parameters for IP6 address configuration
0x05084000 Network Interface Parameters for IP6 address status

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x05000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.
0x05000001 network interface DOS protection active time RO 0 Bits[31:0] = time that DOS protection has been active on the network interface in clock ticks. Reading this register will cause
it to be reset to 0.
0x05000002 network interface DOS protection active incidents RO 0 Bits[31:0] = number of active incidents that have been detected on the network interface

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for Ethernet

[Back to index | Back to parent block]
Address Name RW Default Description
0x05004000 ethernet address bytes 0-3 RO 1 Ethernet Address comprise of 6 bytes [0,1,2,3,4,5].
Bits[31:24] = Ethernet address byte 0
Bits[23:16] = Ethernet address byte 1
Bits[15:8] = Ethernet address byte 2
Bits[7:0] = Ethernet address byte 3
0x05004001 ethernet address bytes 4-5 RO 1 Bits[31:24] = Ethernet address byte 4
Bits[23:16] = Ethernet address byte 5
Bit[15:0] = Reserved
0x05004002 Reserved - - Reserved
0x05004003 Reserved - - Reserved

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for Ethernet Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x05008000 received Ethernet packets RO 0 Bits[31:0] = Number of received Ethernet packets
0x05008001 received Ethernet missed packets RO 0 Bits[31:0] = Number of missed received Ethernet packets
0x05008002 received Ethernet discarded packets RO 0 Bits[31:0] = Number of discarded received Ethernet packets
0x05008003 received Ethernet packets with errors RO 0 Bits[31:0] = Number of received Ethernet packets with errors
0x05008004 received Ethernet packets with crc errors RO 0 Bits[31:0] = Number of received Ethernet packets with CRC errors
0x05008005 transmitted Ethernet packets RO 0 Bits[31:0] = Number of transmitted Ethernet packets
0x05008006 transmitted Ethernet missed packets RO 0 Bits[31:0] = Number of transmitted Ethernet packets that were missed
0x05008007 transmitted Ethernet discarded packets RO 0 Bits[31:0] = Number of discarded transmitted Ethernet packets
0x05008008 transmitted Ethernet packets with errors RO 0 Bits[31:0] = Number of transmitted Ethernet packets with errors
0x05008009 Reserved - - Reserved
0x0500800A Reserved - - Reserved
0x0500800B Reserved - - Reserved
0x0500800C Reserved - - Reserved
0x0500800D Reserved - - Reserved
0x0500800E Reserved - - Reserved
0x0500800F Reserved - - Reserved
0x05008010 Reserved - - Reserved
0x05008011 Reserved - - Reserved
0x05008012 Reserved - - Reserved
0x05008013 Reserved - - Reserved
0x05008014 Reserved - - Reserved

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x0500C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x0500C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x0500C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x0500C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for PCS

[Back to index | Back to parent block]
Address Name RW Default Description
0x05014000 SGMII configuration RO 0 Bits[31:2] = Reserved
Bits[1] = SGMII mode. Valid values:
0 SGMII is in PHY mode
1 SGMII is in MAC mode
Bit[0] = MII mode. Valid values:
0 MII mode
1 SGMII mode
0x05014001 PCS control register RW 0x00001140 Bits[31:16] = Reserved
Bit [15] = PCS Reset. Valid Values:
0 Normal operation
1 Generate a synchronous reset pulse to reset SGMII core (Self-Clearing)
Bit [14] = Loopback. Valid Values:
0 Normal operation
1 Serial loopback is implemented in SGMII Core
Bit [13] = Reserved
Bit [12] = Auto Negotiation Enable. Valid Values:
0 Auto Negotiation disabled
1 Auto Negotiation enabled (default reset value)
Bits[11:10] = Reserved
Bit [9] = Restart Auto Negotiation. Valid Values:
0 Normal operation
1 Restart an Auto Negotiation sequence. (Self-Clearing)
Bits[8:0] = Reserved
0x05014002 PCS status register RO 0 Bits[31:0] = As defined in IEEE 802.3-2012 Clause 22.2.4.2
0x05014003 PCS device ability register RO 0 These are all Read only bits, used by the SGMII PHY to advertise various capabilities
Bits[31:16] = Reserved
Bit [15] = Copper Link Status. Valid Values:
0 Copper interface link is down
1 Copper interface link is up
Bit [14] = Acknowledgement bit used during autonegotiation.
Setting of the bit in the device ability advertisement register is not relevant to the
operation of the autonegotiation function. The bit is typically set in the received partner
ability register upon successful completion of autonegotiation.
Bit [13] = Reserved
Bit [12] = Copper Duplex Status. Valid Values:
0 Copper Interface resolved to Half-Duplex
1 Copper Interface resolved to Full-Duplex
Bits[11:10] = Copper Speed. Valid Values:
00 Copper Interface Speed is 10Mbps
01 Copper Interface Speed is 100Mbps
10 Copper Interface Speed is Gigabit
11 Reserved
Bits[9:0] = Reserved
0x05014004 PCS partner ability register RO 0 These are all Read only bits, used by the SGMII PHY to advertise various capabilities
Bits[31:16] = Reserved
Bit [15] = Copper Link Status. Valid Values:
0 Copper interface link is down
1 Copper interface link is up
Bit [14] = Acknowledgement bit used during autonegotiation.
Setting of the bit in the device ability advertisement register is not relevant to the
operation of the autonegotiation function. The bit is typically set in the received partner
ability register upon successful completion of autonegotiation.
Bit [13] = Reserved
Bit [12] = Copper Duplex Status. Valid Values:
0 Copper Interface resolved to Half-Duplex
1 Copper Interface resolved to Full-Duplex
Bits[11:10] = Copper Speed. Valid Values:
00 Copper Interface Speed is 10Mbps
01 Copper Interface Speed is 100Mbps
10 Copper Interface Speed is Gigabit
11 Reserved
Bits[9:0] = Reserved
0x05014005 PCS interface mode register RO 0 Bits[31:0] = Reserved
0x05014006 SERDES control register RO 0 Bits[31:0] = Reserved
0x05014007 SERDES status register RO 0 Bits[31:0] = Reserved
0x05014008 SGMII lock value RO 0 Bits[31:0] = SGMII Reference Clock Frequency – indicates the relative frequency offset between
the local SGMII reference clock and the ToPSync REFCLK input.
The value indicates the offset in steps of 0.3 ppm, with a value of 0x00320000 indicating perfect alignment.
For reliable operation the value should be between 0x0031FEA2 and 0x0032015E.
An out of range value could indicate a missing local SGMII reference clock.

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x05018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x05018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x05018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x05018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x05018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x05018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x05018010 IP4 address multi-home index 1 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 1 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05018011 IP4 address multi-home index 1 RW 0 Bits[31:0] = IP4 address to be configured multi-home index 1.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x05018012 IP4 subnet mask multi-home index 1 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 1.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x05018020 IPv4 address multi-home index 2 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 2 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05018021 IP4 address multi-home index 2 RW 0 Bits[31:0] = IP4 address multi-home index 2.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x05018022 IP4 subnet mask multi-home index 2 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 2.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x05018030 IPv4 address multi-home index 3 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = ip4 address multi-home index 3 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05018031 IP4 address multi-home index 3 RW 0 Bits[31:0] = IP4 address multi-home index 3.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x05018032 IP4 subnet mask multi-home index 3 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 3.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x05018040 IPv4 address multi-home index 4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05018041 IP4 address multi-home index 4 RW 0 Bits[31:0] = IP4 address multi-home index 4.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x05018042 IP4 subnet mask multi-home index 4 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 4.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x05018050 IPv4 address multi-home index 5 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 address multi-home index 5 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05018051 IP4 address multi-home index 5 RW 0 Bits[31:0] = IP4 address multi-home index 5.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x05018052 IP4 subnet mask multi-home index 5 RW 0 Bits[31:0] = IP4 subnet mask multi-home index 5.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x0501C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x0501C001 Reserved - - Reserved
0x0501C002 Reserved - - Reserved
0x0501C003 Reserved - - Reserved
0x0501C004 Reserved - - Reserved
0x0501C005 Reserved - - Reserved
0x0501C006 Reserved - - Reserved
0x0501C007 Reserved - - Reserved
0x0501C008 Reserved - - Reserved
0x0501C009 Reserved - - Reserved
0x0501C00A Reserved - - Reserved
0x0501C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x0501C00C Reserved - - Reserved
0x0501C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x0501C00E Reserved - - Reserved
0x0501C00F Reserved - - Reserved
0x0501C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x0501C011 Reserved - - Reserved
0x0501C012 Reserved - - Reserved
0x0501C013 Reserved - - Reserved
0x0501C014 Reserved - - Reserved
0x0501C015 Reserved - - Reserved
0x0501C016 Reserved - - Reserved
0x0501C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x0501C018 Reserved - - Reserved
0x0501C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x0501C01A Reserved - - Reserved
0x0501C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x0501C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x05020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x05020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x05020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x05020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x05020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x05020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x05020010 IP4 address multi-home index 1 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 1 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x05020011 IP4 address multi-home index 1 RO 0 Bits[31:0] = IP4 address multi-home index 1
0x05020012 IP4 subnet mask multi-home index 1 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 1
0x05020020 IP4 address multi-home index 2 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 2 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x05020021 IP4 address multi-home index 2 RO 0 Bits[31:0] = IP4 address
0x05020022 IP4 subnet mask multi-home index 2 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 2
0x05020030 ip4 address multi-home index 3 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 3 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x05020031 IP4 address multi-home index 3 RO 0 Bits[31:0] = IP4 address multi-home index 3
0x05020032 IP4 subnet mask multi-home index 3 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 3
0x05020040 IP4 address multi-home index 4 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 4 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x05020041 IP4 address multi-home index 4 RO 0 Bits[31:0] = IP4 address multi-home index 4
0x05020042 IP4 subnet mask multi-home index 4 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 4
0x05020050 IP4 address multi-home index 5 configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 address multi-home index 5 enabled. Valid values:
0 IP4 disabled
1 IP4 enabled
0x05020051 IP4 address multi-home index 5 RO 0 Bits[31:0] = IP4 address multi-home index 5
0x05020052 IP4 subnet mask multi-home index 5 RO 0 Bits[31:0] = IP4 subnet mask multi-home index 5

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x05040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x05040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x05040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x05040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x05040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x05040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x05040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x05044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x05044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x05044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x05044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x05044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x05044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x05044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x05044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x05044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x05044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0504401A Reserved - - Reserved
0x0504401B Reserved - - Reserved
0x05044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x05044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x05044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x05044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x05044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x05044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x05044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0504402A Reserved - - Reserved
0x0504402B Reserved - - Reserved
0x05044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x05044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x05044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x05044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x05044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x05044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x05044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0504403A Reserved - - Reserved
0x0504403B Reserved - - Reserved
0x05044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x05044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x05044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x05044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x05044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x05044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x05044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0504404A Reserved - - Reserved
0x0504404B Reserved - - Reserved
0x05044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x05044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x05044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x05044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x05044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x05044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x05044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x0504405A Reserved - - Reserved
0x0504405B Reserved - - Reserved
0x05044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x05044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x05044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x05044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x05044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x05044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x05044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x05044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x05044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x05044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x05044FF3 Reserved - - Reserved
0x05044FF4 Reserved - - Reserved

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x05080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x05080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x05080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x05080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x0508000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x0508000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x05080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080040 configuration control for IP6 address multi-home index 1 RW 1 Bits[31:1] = Reserved
Bit[1:0] = ip6 address multi-home index 1 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05080041 IP6 address multi-home index 1 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080042 IP6 address multi-home index 1 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080043 IP6 address multi-home index 1 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080044 IP6 address multi-home index 1 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 1 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080045 IP6 address multi-home index 1 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 1 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080050 IP6 address multi-home index 2 configuration control RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 address multi-home index 2 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05080051 IP6 address multi-home index 2 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080052 IP6 address multi-home index 2 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080053 IP6 address multi-home index 2 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080054 IP6 address multi-home index 2 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 2 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080055 IP6 address multi-home index 2 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 2 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080060 IP6 address multi-home index 3 configuration control RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 multi-home index 3 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05080061 IP6 address multi-home index 3 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080062 IP6 address multi-home index 3 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080063 IP6 address multi-home index 3 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080064 IP6 address multi-home index 3 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 3 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080065 IP6 address multi-home index 3 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 3 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080070 IP6 address multi-home index 4 configuration control RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 address multi-home index 4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05080071 IP6 address multi-home index 4 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080072 IP6 address multi-home index 4 bytes 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080073 IP6 address multi-home index 4 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080074 IP6 address multi-home index 4 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 4 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080075 IP6 address multi-home index 4 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 4 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080080 IP6 address multi-home index 5 prefix length RW 1 Bits[31:1] = Reserved
Bit[1:0] = IP6 address multi-home index 5 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
A ToPSync should not be configured with more than 6 IP addresses.
0x05080081 IP6 address multi-home index 5 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080082 IP6 address multi-home index 5 byte 4..7 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080083 IP6 address multi-home index 5 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080084 IP6 address multi-home index 5 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 5 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x05080085 IP6 address multi-home 5 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 5 prefix length.
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.

Network Interface 2 Configuration (physical port 1, virtual port 0) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x05084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x05084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x05084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x05084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x0508400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x0508400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x05084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x05084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x05084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x05084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x05084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x05084016 Reserved - - Reserved
0x05084017 Reserved - - Reserved
0x05084040 IP6 address multi-home index 1 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 address multi-home index 1 control configuration status. Valid values:
0 IP6 address multi-home index 1 disabled
1 IP6 address multi-home index 1 enabled
0x05084041 IP6 address multi-home index 1 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 0 to 3 status
0x05084042 IP6 address multi-home index 1 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 4 to 7 status
0x05084043 IP6 address multi-home index 1 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 8 to 11 status
0x05084044 IP6 address multi-home index 1 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 1 bytes 12 to 15 status
0x05084045 IP6 address multi-home index 1 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 1 prefix length status
0x05084046 Reserved - - Reserved
0x05084047 Reserved - - Reserved
0x05084050 IP6 address multi-home index 2 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 2 disabled
1 IP6 address multi-home index 2 enabled
0x05084051 IP6 address multi-home index 2 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 0 to 3 status
0x05084052 IP6 address multi-home index 2 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 4 to 7 status
0x05084053 IP6 address multi-home index 2 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 8 to 11 status
0x05084054 IP6 address multi-home index 2 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 2 bytes 12 to 15 status
0x05084055 IP6 address multi-home index 2 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 2 prefix length status
0x05084056 Reserved - - Reserved
0x05084057 Reserved - - Reserved
0x05084060 IP6 address multi-home index 3 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 3 disabled
1 IP6 address multi-home index 3 enabled
0x05084061 IP6 address multi-home index 3 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 0 to 3 status
0x05084062 IP6 address multi-home index 3 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 4 to 7 status
0x05084063 IP6 address multi-home index 3 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 8 to 11 status
0x05084064 IP6 address multi-home index 3 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 3 bytes 12 to 15 status
0x05084065 IP6 address multi-home index 3 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 3 prefix length status
0x05084066 Reserved - - Reserved
0x05084067 Reserved - - Reserved
0x05084070 IP6 address multi-home index 4 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 4 disabled
1 IP6 address multi-home index 4 enabled
0x05084071 IP6 address multi-home index 4 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 0 to 3 of address status
0x05084072 IP6 address multi-home index 4 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 4 to 7 of address status
0x05084073 IP6 address multi-home index 4 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 8 to 11 of address status
0x05084074 IP6 address multi-home index 4 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 4 bytes 12 to 15 of address status
0x05084075 IP6 address multi-home index 4 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 4 prefix length of address status
0x05084076 Reserved - - Reserved
0x05084077 Reserved - - Reserved
0x05084080 IP6 address multi-home index 5 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 5 disabled
1 IP6 address multi-home index 5 enabled
0x05084081 IP6 address multi-home index 5 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 0 to 3 status
0x05084082 IP6 address multi-home index 5 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 4 to 7 status
0x05084083 IP6 address multi-home index 5 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 8 to 11 status
0x05084084 IP6 address multi-home index 5 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 5 bytes 12 to 15 status
0x05084085 IP6 address multi-home index 5 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 5 prefix length status
0x05084086 Reserved - - Reserved
0x05084087 Reserved - - Reserved
0x05084090 Reserved - - Reserved
0x05084091 Reserved - - Reserved
0x05084092 Reserved - - Reserved
0x05084093 Reserved - - Reserved
0x05084094 Reserved - - Reserved
0x05084095 Reserved - - Reserved
0x05084096 Reserved - - Reserved
0x05084097 Reserved - - Reserved
0x050840A0 Reserved - - Reserved
0x050840A1 Reserved - - Reserved
0x050840A2 Reserved - - Reserved
0x050840A3 Reserved - - Reserved
0x050840A4 Reserved - - Reserved
0x050840A5 Reserved - - Reserved
0x050840A6 Reserved - - Reserved
0x050840A7 Reserved - - Reserved
0x050840B0 IP6 address multi-home index 8 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 8 disabled
1 IP6 address multi-home index 8 enabled
0x050840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x050840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x050840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x050840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x050840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x050840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x050840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x050840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x050840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x050840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x050840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x050840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x050840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x050840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x050840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x050840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x050840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x050840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x050840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x050840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x050840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x050840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x050840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x050840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x050840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x050840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x050840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x050840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x050840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x050840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x050840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x050840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x050840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x050840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x050840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x050840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x050840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x050840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x050840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x05084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x05084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x05084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x05084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x05084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x05084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x05084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x05084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x05084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x05084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x05084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x05084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x05084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x05084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x05084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x05084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Time Of Day Interface 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x07000000 TOD configuration parameters
0x07004000 TOD input status
0x07008000 NMEA sentence configuration

Time Of Day Interface 1 Configuration : TOD configuration parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x07000000 enable/disable uart to receive TOD messages RW 0 Bits[31:1] = Reserved
Bit[0] = Enable uart to receive TOD
Valid values:
0: Disabled
1: Enabled
0x07000001 enable/disable uart to transmit TOD messages RW 0 Bits[31:1] = Reserved
Bit[0] = Enable uart to transmit TOD
Valid values:
0: Disabled
1: Enabled
0x07000002 Baud Rate for uart RW 4800 Bits[31:0] = Baud Rate e.g. 1200, 2400, 4800, 9600, 19200
0x07000003 TOD code for receive RW 1 Bits[31:1] = reserved
Bits[0] = TOD_CODE
Valid values:
1 - NMEA
0x07000004 TOD code for transmit RW 1 Bits[31:1] = reserved
Bits[0] = TOD_CODE
Valid values:
1 - NMEA
0x07000005 clock PLL index for receive RW 0 Bits[31:2] = reserved
Bits[1:0] = Clock PLL index
Valid values:
1 - Clock PLL 1
2 - Clock PLL 2
0x07000006 Node Time index for transmit RW 0 Bits[31:2] = reserved
Bits[1:0] = Node Time index
Valid values:
1 - Node Time 1
2 - Node Time 2

Time Of Day Interface 1 Configuration : TOD input status

[Back to index | Back to parent block]
Address Name RW Default Description
0x07004000 number of TOD messages received RO 0 Bits[31:0] = Number of TOD messages received
0x07004001 time in last sentence received MS seconds (epoch bits) RO 0 Bits[31:16] = Reserved
Bits[15:0] = Last sentence received (seconds bits 47 to 32)
This contains the epoch of the seconds taken from the time in the last message received.
0x07004002 time in last sentence received (seconds) RO 0 Bits[31:0] = Last sentence received (seconds bits 31 to 0)
These are the lower 32 bits of the seconds taken from the time in the last message received.
0x07004003 time in last sentence received (nanoseconds) RO 0 Bits[31:0] = Last sentence received (nanoseconds)
0x07004004 Reserved - - Reserved
0x07004010 last sentence received word 1 RO 0 Bits[31:0] = Last sentence received word 1
0x07004011 last sentence received word 2 RO 0 Bits[31:0] = Last sentence received word 2
0x07004012 last sentence received word 3 RO 0 Bits[31:0] = Last sentence received word 3
0x07004013 last sentence received word 4 RO 0 Bits[31:0] = Last sentence received word 4
0x07004014 last sentence received word 5 RO 0 Bits[31:0] = Last sentence received word 5
0x07004015 last sentence received word 6 RO 0 Bits[31:0] = Last sentence received word 6
0x07004016 last sentence received word 7 RO 0 Bits[31:0] = Last sentence received word 7
0x07004017 last sentence received word 8 RO 0 Bits[31:0] = Last sentence received word 8
0x07004018 last sentence received word 9 RO 0 Bits[31:0] = Last sentence received word 9
0x07004019 last sentence received word 10 RO 0 Bits[31:0] = Last sentence received word 10
0x0700401A last sentence received word 11 RO 0 Bits[31:0] = Last sentence received word 11
0x0700401B last sentence received word 12 RO 0 Bits[31:0] = Last sentence received word 12
0x0700401C last sentence received word 13 RO 0 Bits[31:0] = Last sentence received word 13
0x0700401D last sentence received word 14 RO 0 Bits[31:0] = Last sentence received word 14
0x0700401E last sentence received word 15 RO 0 Bits[31:0] = Last sentence received word 15
0x0700401F last sentence received word 16 RO 0 Bits[31:0] = Last sentence received word 16
0x07004020 last sentence received word 17 RO 0 Bits[31:0] = Last sentence received word 17
0x07004021 last sentence received word 18 RO 0 Bits[31:0] = Last sentence received word 18
0x07004022 last sentence received word 19 RO 0 Bits[31:0] = Last sentence received word 19
0x07004023 last sentence received word 20 RO 0 Bits[31:0] = Last sentence received word 20
0x07004024 last sentence received word 21 RO 0 Bits[31:0] = Last sentence received word 21
0x07004025 last sentence received word 22 RO 0 Bits[31:0] = Last sentence received word 22
0x07004026 last sentence received word 23 RO 0 Bits[31:0] = Last sentence received word 23
0x07004027 last sentence received word 24 RO 0 Bits[31:0] = Last sentence received word 24
0x07004028 last sentence received word 25 RO 0 Bits[31:0] = Last sentence received word 25

Time Of Day Interface 1 Configuration : NMEA sentence configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x07008000 NMEA active sentence configuration RW 0x1 Bits[31:0] = NMEA active sentence configuration bit fields. The following are valid bit fields values:
0x01 - NMEA RMC sentence
0x02 - NMEA GGA sentence
0x04 - NMEA ZDA sentence
0x08 - SemTech time sentence
0x10 - Semtech frequency sentence
0x20 - Semtech time short sentence (IRIG)
0x40 - Semtech time information sentence
0x80 - Semtech time status sentence
0x07008001 SMTC proprietary message time format configuration RW 0x0 Bits[31:0] = SMTC proprietary message time format configuration. The following are valid values:
0x00 - TAI
0x01 - UTC
0x02 - GPS
0x07008002 SMTC proprietary message time alignment RW 0x0 Bits[31:0] = SMTC proprietary message time alignment
0x00 - Time is aligned to the preceding PPnS edge
0x01 - Time is aligned to the next PPnS edge
0x07008010 SMTC proprietary message data byte 1 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 1
0x07008011 SMTC proprietary message data byte 2 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 2
0x07008012 SMTC proprietary message data byte 3 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 3
0x07008013 SMTC proprietary message data byte 4 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 4
0x07008014 SMTC proprietary message data byte 5 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 5
0x07008015 SMTC proprietary message data byte 6 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 6
0x07008016 SMTC proprietary message data byte 7 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 7
0x07008017 SMTC proprietary message data byte 8 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 8
0x07008018 SMTC proprietary message data byte 9 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 9
0x07008019 SMTC proprietary message data byte 10 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 10
0x0700801A SMTC proprietary message data byte 11 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 11
0x0700801B SMTC proprietary message data byte 12 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 12
0x0700801C SMTC proprietary message data byte 13 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 13
0x0700801D SMTC proprietary message data byte 14 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 14
0x0700801E SMTC proprietary message data byte 15 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 15
0x0700801F SMTC proprietary message data byte 16 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 16
0x07008020 SMTC proprietary message data byte 17 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 17
0x07008021 SMTC proprietary message data byte 18 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 18
0x07008022 SMTC proprietary message data byte 19 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 19
0x07008023 SMTC proprietary message data byte 20 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 20
0x07008024 SMTC proprietary message data byte 21 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 21
0x07008025 SMTC proprietary message data byte 22 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 22
0x07008026 SMTC proprietary message data byte 23 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 23. This is read-only and is used for a checksum.

Time Of Day Interface 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x08000000 TOD configuration parameters
0x08004000 TOD input status
0x08008000 NMEA sentence configuration

Time Of Day Interface 2 Configuration : TOD configuration parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x08000000 enable/disable uart to receive TOD messages RW 0 Bits[31:1] = Reserved
Bit[0] = Enable uart to receive TOD
Valid values:
0: Disabled
1: Enabled
0x08000001 enable/disable uart to transmit TOD messages RW 0 Bits[31:1] = Reserved
Bit[0] = Enable uart to transmit TOD
Valid values:
0: Disabled
1: Enabled
0x08000002 Baud Rate for uart RW 4800 Bits[31:0] = Baud Rate e.g. 1200, 2400, 4800, 9600, 19200
0x08000003 TOD code for receive RW 1 Bits[31:1] = reserved
Bits[0] = TOD_CODE
Valid values:
1 - NMEA
0x08000004 TOD code for transmit RW 1 Bits[31:1] = reserved
Bits[0] = TOD_CODE
Valid values:
1 - NMEA
0x08000005 clock PLL index for receive RW 0 Bits[31:2] = reserved
Bits[1:0] = Clock PLL index
Valid values:
1 - Clock PLL 1
2 - Clock PLL 2
0x08000006 Node Time index for transmit RW 0 Bits[31:2] = reserved
Bits[1:0] = Node Time index
Valid values:
1 - Node Time 1
2 - Node Time 2

Time Of Day Interface 2 Configuration : TOD input status

[Back to index | Back to parent block]
Address Name RW Default Description
0x08004000 number of TOD messages received RO 0 Bits[31:0] = Number of TOD messages received
0x08004001 time in last sentence received MS seconds (epoch bits) RO 0 Bits[31:16] = Reserved
Bits[15:0] = Last sentence received (seconds bits 47 to 32)
This contains the epoch of the seconds taken from the time in the last message received.
0x08004002 time in last sentence received (seconds) RO 0 Bits[31:0] = Last sentence received (seconds bits 31 to 0)
These are the lower 32 bits of the seconds taken from the time in the last message received.
0x08004003 time in last sentence received (nanoseconds) RO 0 Bits[31:0] = Last sentence received (nanoseconds)
0x08004004 Reserved - - Reserved
0x08004010 last sentence received word 1 RO 0 Bits[31:0] = Last sentence received word 1
0x08004011 last sentence received word 2 RO 0 Bits[31:0] = Last sentence received word 2
0x08004012 last sentence received word 3 RO 0 Bits[31:0] = Last sentence received word 3
0x08004013 last sentence received word 4 RO 0 Bits[31:0] = Last sentence received word 4
0x08004014 last sentence received word 5 RO 0 Bits[31:0] = Last sentence received word 5
0x08004015 last sentence received word 6 RO 0 Bits[31:0] = Last sentence received word 6
0x08004016 last sentence received word 7 RO 0 Bits[31:0] = Last sentence received word 7
0x08004017 last sentence received word 8 RO 0 Bits[31:0] = Last sentence received word 8
0x08004018 last sentence received word 9 RO 0 Bits[31:0] = Last sentence received word 9
0x08004019 last sentence received word 10 RO 0 Bits[31:0] = Last sentence received word 10
0x0800401A last sentence received word 11 RO 0 Bits[31:0] = Last sentence received word 11
0x0800401B last sentence received word 12 RO 0 Bits[31:0] = Last sentence received word 12
0x0800401C last sentence received word 13 RO 0 Bits[31:0] = Last sentence received word 13
0x0800401D last sentence received word 14 RO 0 Bits[31:0] = Last sentence received word 14
0x0800401E last sentence received word 15 RO 0 Bits[31:0] = Last sentence received word 15
0x0800401F last sentence received word 16 RO 0 Bits[31:0] = Last sentence received word 16
0x08004020 last sentence received word 17 RO 0 Bits[31:0] = Last sentence received word 17
0x08004021 last sentence received word 18 RO 0 Bits[31:0] = Last sentence received word 18
0x08004022 last sentence received word 19 RO 0 Bits[31:0] = Last sentence received word 19
0x08004023 last sentence received word 20 RO 0 Bits[31:0] = Last sentence received word 20
0x08004024 last sentence received word 21 RO 0 Bits[31:0] = Last sentence received word 21
0x08004025 last sentence received word 22 RO 0 Bits[31:0] = Last sentence received word 22
0x08004026 last sentence received word 23 RO 0 Bits[31:0] = Last sentence received word 23
0x08004027 last sentence received word 24 RO 0 Bits[31:0] = Last sentence received word 24
0x08004028 last sentence received word 25 RO 0 Bits[31:0] = Last sentence received word 25

Time Of Day Interface 2 Configuration : NMEA sentence configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x08008000 NMEA active sentence configuration RW 0x1 Bits[31:0] = NMEA active sentence configuration bit fields. The following are valid bit fields values:
0x01 - NMEA RMC sentence
0x02 - NMEA GGA sentence
0x04 - NMEA ZDA sentence
0x08 - SemTech time sentence
0x10 - Semtech frequency sentence
0x20 - Semtech time short sentence (IRIG)
0x40 - Semtech time information sentence
0x80 - Semtech time status sentence
0x08008001 SMTC proprietary message time format configuration RW 0x0 Bits[31:0] = SMTC proprietary message time format configuration. The following are valid values:
0x00 - TAI
0x01 - UTC
0x02 - GPS
0x08008002 SMTC proprietary message time alignment RW 0x0 Bits[31:0] = SMTC proprietary message time alignment
0x00 - Time is aligned to the preceding PPnS edge
0x01 - Time is aligned to the next PPnS edge
0x08008010 SMTC proprietary message data byte 1 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 1
0x08008011 SMTC proprietary message data byte 2 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 2
0x08008012 SMTC proprietary message data byte 3 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 3
0x08008013 SMTC proprietary message data byte 4 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 4
0x08008014 SMTC proprietary message data byte 5 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 5
0x08008015 SMTC proprietary message data byte 6 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 6
0x08008016 SMTC proprietary message data byte 7 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 7
0x08008017 SMTC proprietary message data byte 8 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 8
0x08008018 SMTC proprietary message data byte 9 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 9
0x08008019 SMTC proprietary message data byte 10 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 10
0x0800801A SMTC proprietary message data byte 11 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 11
0x0800801B SMTC proprietary message data byte 12 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 12
0x0800801C SMTC proprietary message data byte 13 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 13
0x0800801D SMTC proprietary message data byte 14 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 14
0x0800801E SMTC proprietary message data byte 15 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 15
0x0800801F SMTC proprietary message data byte 16 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 16
0x08008020 SMTC proprietary message data byte 17 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 17
0x08008021 SMTC proprietary message data byte 18 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 18
0x08008022 SMTC proprietary message data byte 19 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 19
0x08008023 SMTC proprietary message data byte 20 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 20
0x08008024 SMTC proprietary message data byte 21 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 21
0x08008025 SMTC proprietary message data byte 22 RW 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 22
0x08008026 SMTC proprietary message data byte 23 RO 0 Bits[31:8] = Reserved
Bits[7:0] = SMTC proprietary message data byte 23. This is read-only and is used for a checksum.

Local Oscillator Configuration : Sub Blocks

[Back to index]
Start Address Description
0x09000000 Local Oscillator Reference Clock
0x09004000 Local Oscillator Configuration

Local Oscillator Configuration : Local Oscillator Reference Clock

[Back to index | Back to parent block]
Address Name RW Default Description
0x09000000 Node ID bytes 0-3 RW 0 Bits[31:24] Node ID byte 0 (Most significant byte of the 8-byte node ID)
Bits[23:16] Node ID byte 1
Bits[15:8] Node ID byte 2
Bits[7:0] Node ID byte 3
0x09000001 Node ID bytes 4-7 RW 0 Bits[31:24] Node ID byte 4
Bits[23:16] Node ID byte 5
Bits[15:8] Node ID byte 6
Bits[7:0] Node ID byte 7 (Least significant byte of the 8-byte node ID)
0x09000002 Clock Class RW 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
0x09000003 Time Source RW 0 Bits[31:3] Reserved
Bits[2:0] Time source. Allowed values
000 Atomic clock
001 GPS
010 Terrestrial (radio)
011 PTP
100 NTP
101 Hand set
110 Other source
111 internalOscillator. No time reference at all
1000 smpte time source F0 (arb)
1001 smpte time source F1
0x09000004 Clock Accuracy RW 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock Accuracy. Allowed values:
0x20 NS25 The time is accurate to within 25 ns
0x21 NS100 The time is accurate to within 100 ns
0x22 NS250 The time is accurate to within 250 ns
0x23 US1 The time is accurate to within 1 us
0x24 US2_5 The time is accurate to within 2.5 us
0x25 US10 The time is accurate to within 10 us
0x26 US25 The time is accurate to within 25 us
0x27 US100 The time is accurate to within 100 us
0x28 US250 The time is accurate to within 250 us
0x29 MS1 The time is accurate to within 1 ms
0x2A MS2_5 The time is accurate to within 2.5 ms
0x2B MS10 The time is accurate to within 10 ms
0x2C MS25 The time is accurate to within 25 ms
0x2D MS100 The time is accurate to within 100 ms
0x2E MS250 The time is accurate to within 250 ms
0x2F S1 The time is accurate to within 1 s
0x30 S10 The time is accurate to within 10 s
0x31 GT10S The time is accurate to >10 s
0xFE ACC_UNKNOWN The time accuracy is unknown
0x09000005 Offset scaled log variance RW 0 Bits[31:16] Reserved
Bits[15:0] IEEE1588 Offset scaled log variance defined in 1588 v2 7.6.3.3
0x09000006 Time valid RW 0 Bits[31:1] Reserved
Bits[0] 1 - The time is a valid TAI time, 0 otherwise
0x09000007 Priority 1 value RW 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x09000008 Priority 2 value RW 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x09000009 Steps removed value RW 0 Bits[31:16] Reserved
Bits[15:0] Steps removed value

Local Oscillator Configuration : Local Oscillator Configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x09004000 Local Oscillator frequency offset RW 0 Bits[31:0] = Applied frequency offset in Hz expressed as a single precision floating point number.
The maximum value for this is +-0.0001
This register is provided for oscillator calibration.

PTP Slave Port 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x0A000000 General Parameters
0x0A004000 Generic Parameters
0x0A008000 Detailed setup for both PTP mode and Timestamp processor mode.
0x0A00C000 Read only PTP slave statistics.
0x0A010000 Subsystem to allow user defined data to be sent between devices
0x0A014000 Subsystem to allow user defined data to be received between devices
0x0A018000 Subsystem to allow smpte data to be received between devices

PTP Slave Port 1 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A000000 physical port connector RW 0 Bits[31:8] reserved
Bits[7:0] connector. The physical port that this ptp port is connected to, starting from 0.
Notes: It is recommended that the first five words, connector, protocol, version, domain and configure are set at the same time.
0x0A000001 ptp port protocol RW 0 Bits[31:2] reserved
Bits[1:0] protocol. The protocol used in the ptp port.
0 udp4,
1 ethernet,
2 udp6
0x0A000002 ptp port version RO 2 Bits[31:3] reserved
Bits[2:0] version
1 version1,
2 version2
0x0A000003 ptp port domain RW 0 Bits[31:8] reserved
Bits[7:0] domain (starting from 0)
Notes: Set the domain number of the ptp port. This can be set at the same time as configuring the ptp port.
It can also be set by itself when a ptp port has already been configured.
It will only be able to communicate with other ptp ports on the same domain.
0x0A000004 configure ptp port RW 0 Bits[31:1] reserved
Bits[0:0] configure
0 deconfigure,
1 configure
Notes: Resets the PTP port, then configures the ptp port with the settings 'physical port connector', 'ptp port protocol', 'ptp port version' and 'domain' (registers 0x0A000000 through 0x0A000003). The mode configurations will also be applied at this point (see registers 0x0A008000 through 0x0A008012). Finally the network interface is enabled and the PTP port enters the listening state.
Notes: Deconfiguring a port will also disable the port.
0x0A000005 enable ptp port RW 0 Bits[31:1] reserved
Bits[0:0] enable
0 disable,
1 enable
Enables the ptp port for use. If enabled it will allow the ptp port to begin moving through it's states and PTP traffic to flow.
Notes: A PTP port must be configured (0x0A000004) before it can be enabled or disabled. Disabling a PTP port does not deconfigure it.
0x0A000007 virtual interface number RW 0 Bits[31:3] reserved
Bits[2:0] virtual interface number
0x0A000008 multi home index of address on interface RW 0 Bits[31:4] reserved
Bits[3:0] multi home index of address on interface
0x0A000010 The node id of the ptp port bytes 0 to 3 RW 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these two node id words in one go.
0x0A000011 The node id of the ptp port bytes 4 to 7 RW 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these two node id words in one go.
0x0A000012 The default node id of the ptp port RO 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x0A000013 The default id of the ptp port RO 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x0A000014 The state of the ptp port RO 0x0 Bits[31:4] reserved
Bits[3:0] state of the ptp port
0 = portFaulty,
1 = portDisabled,
2 = portListening,
3 = portPreMaster,
4 = portMaster,
5 = portPassive,
6 = portUncalibrated,
7 = portSlave
0x0A000015 best master clock algorithm mask RW 0xBF Bits[31:8] = reserved
Bits[7:0] = mask
0x01 GM Priority1
0x02 GM Identity
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values
0x100 Local Priority
Notes: Configures which steps in the best master clock algorithm are performed.
The default value is 0xBF, ie all steps enabled except for Steps Removed and Local Priority
0x0A000016 better master available flag RO 0x0 Bits[31:1] = reserved
Bits[0:0] = flag
0 = true,
1 = false
Notes: This indicates if there is a better master available than the currently selected master.
0x0A000018 Reserved - - Reserved
0x0A000020 Reserved - - Reserved
0x0A000021 required unicast announce log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: required unicast log period of the announce message.
The desired log period is the smallest (and hence fastest rate) that is desired.
The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0A000022 required unicast announce duration RW 250 Bits[31:0] duration
Notes: Set duration of the required unicast grant duration of the announce message.
0x0A000023 desired unicast announce log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Set desired unicast log period of the announce message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0A000024 Reserved - - Reserved
0x0A000025 required unicast sync log period RW -3 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set required unicast log period of the sync message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
It is recommended to set this and the next two parameters at the same time.
0x0A000026 required unicast sync duration RW 250 Bits[31:0] duration
Notes: Set duration of the required unicast grant duration of the sync message.
0x0A000027 desired unicast sync log period RW -5 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired unicast log period of the sync message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0A000028 desired multicast delay resp log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired multicast log period of the delay resp message. The desired log period is the smallest
(and hence fastest rate) that is desired. The required log period is the largest (and hence slowest rate) that is
satisfactory to the ptp port.
This setting should only be used on a ptp port that actually provides these multicast messages.
0x0A000029 required unicast delay resp log period RW -3 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set required unicast log period of the delay resp message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
It is recommended to set this and the next two parameters at the same time.
0x0A00002A required unicast delay resp duration RW 250 Bits[31:0] duration
Notes: Set duration of the required delay resp grant duration of the sync message.
0x0A00002B desired unicast delay resp log period RW -5 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired unicast log period of the delay resp message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0A00002C Reserved - - Reserved
0x0A00002D Reserved - - Reserved
0x0A00002E Reserved - - Reserved
0x0A00002F enable DelayRequest send unicast in mluticast mode RW 0 Bits[31:1] Reserved
Bits[0] = 1 - enable, 0 - disable
Note ptp port configure will reset to 0
0x0A000050 use master to slave delays RW 0x1 Bits[31:1] reserved
Bits[0:0] m2s delay
0 = disable,
1 = enable
Notes: Configures the ptp port to use master to slave delays.
It is recommended to set this and the next parameter at the same time.
If this and the next parameter are enabled then delays in both directions will be used.
0x0A000051 use slave to master delays RW 0x1 Bits[31:1] reserved
Bits[0:0] m2s delay
0 = disable,
1 = enable
Notes: Configures the ptp port to use slave to master delays.
It is recommended to set this and the previous parameter at the same time.
If this and the previous parameter are enabled then delays in both directions will be used.
0x0A000052 number of missing announce messages RW 0x5 Bits[31:16] reserved
Bits[15:0] = number of missing announce
Notes: Configures the number of missing announce messages after which the master is considered to be lost.
0x0A000053 enabled forced master operation RW 0x0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the forced master operation. If set then the next parameter gives the visible master index of the device
to be the current master, thus overriding the usual selection method.
It is recommended to set this and the next parameter at the same time.
0x0A000054 visible master index of the forced master RW 0x0 Bits[31:8] = reserved
Bits[7:0] = index (from 0 to max number of visible masters)
Notes: Sets visible master index of the device to be the current master, thus overriding the usual selection method.
It is recommended to set this and the previous parameter at the same time.
0x0A000055 wait to restore time RW 0x0 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Set the time in seconds after which a visible master can be considered to be the current master.
0x0A000056 Enable Revertive Operation On Same Transport RW 0 Bits[31:1] Reserved
Bits[0] = 1 - Revertive operation enabled, 0 - disabled
Note this controls the revertive operation on the PTP port. There is a separate configuration
for revertive operation for Node Time inputs
0x0A000057 Reserved - - Reserved
0x0A000060 Enable protocol of G8273.2 RW 0 Bits[31:1] Reserved
Bits[0] = 1 - the protocol of G8273.2 enabled, 0 - disabled
0x0A000061 Reserved - - Reserved
0x0A000062 enable master fast switch mode RW 0 Bits[31:1] Reserved
Bits[0] = 1 - enable, 0 - disable

PTP Slave Port 1 Configuration : Generic Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A004000 addressing mode RW 0 Bits[31:2] = reserved
Bits[1:0] = addressing mode
asAppropriate = 0,
unicastOnly = 1,
multicastOnly = 2
Notes: Sets the addressing mode of the ptp port.
0x0A004001 enable path delay request messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
This enables sending of path delay request messages.
0x0A004002 master packet interface speed RW 0 Bits[31:0] = speed in bits per second
Notes: Sets the master packet interface speed in bits per second.
0x0A004003 accept ms multicast timing messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to accept master to slave multicast timing messages.
When there are no active unicast grants and this flag is true then it means the timing
situation is good. Thus the state of the visible master can be set to valid - meaning it can be used as
a master.
0x0A004004 enable ms unicast grant requests RW 1 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to make master to slave unicast grant requests. This is on by default.
If this is on and the addressing mode is not multicastOnly then this will enable grant requests to
be made.
0x0A004005 accept sm multicast timing messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to accept slave to master multicast timing messages.
When there are no active unicast grants and this flag is true then it means the timing
situation is good. Thus the state of the visible master can be set to valid - meaning it can be used as
a master.
0x0A004006 enable sm unicast grant requests RW 1 Bits[31:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to make slave to master unicast grant requests. This is on by default
If this is on and the addressing mode is not multicastOnly then this will enable grant requests to
be made.
0x0A00400A enable path delay response messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: This can only be enabled when path delay requests have been disabled.
0x0A00400B path delay value RW 0 Bits[31:0] = delay as a float value
0x0A004010 enable enhanced boundary clock RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the enhanced boundary clock.
0x0A004013 Reserved - - Reserved
0x0A004014 Reserved - - Reserved
0x0A004015 Reserved - - Reserved
0x0A004016 Reserved - - Reserved
0x0A004017 Reserved - - Reserved
0x0A004018 Reserved - - Reserved
0x0A004040 announce grant request threshold RW 20 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the announce grant request threshold - this is the time remaining for a grant after which
new grant requests will be made.
0x0A004041 sync grant request threshold RW 20 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the sync grant request threshold - this is the time remaining for a grant after which
new grant requests will be made.
0x0A004042 delay grant request threshold RW 20 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the delay grant request threshold - this is the time remaining for a grant after which
new grant requests will be made.
0x0A004043 announce grant repeat period RW 2 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the announce grant repeat period - when grant requests are made they will be repeated at this interval.
0x0A004044 sync grant repeat period RW 2 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the sync grant repeat period - when grant requests are made they will be repeated at this interval.
0x0A004045 delay grant repeat period RW 2 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the delay grant repeat period - when grant requests are made they will be repeated at this interval.
0x0A004046 Reserved - - Reserved
0x0A004047 holdoff timer RW 0 Bits[31:0] = time in s, sint32
Notes: Enables the holdoff timer which is the time from when the master is not visible until when the port will
stop considering it as a use-able master. A non zero value will begin this operation.
0x0A004048 primary reference source clock stratum value RW 6 Bits[31:8] = reserved
Bits[7:0] = Clock stratum level
Notes: This value will be used when comparing the clock class on setting the Freq Traceable flag in ptp messages.
The default value is clock stratum level primaryReference (=6)
0x0A004049 network traffic load profile RW 0 Bits[31:2] = reserved
Bits[1:0] = values from below:
normalLoadTraffic = 0,
heavyLoadTraffic = 1,
0x0A00404A override frequency traceable flag RW 0 Bits[31:2] = reserved
Bits[1:1] = if '1' then use the override the frequency traceable flag in ptp messages with the value in bit0.
Bits[0:0] = if '1' then frequency traceable flag is 1
if '0' then frequency traceable flag is 0
0x0A00404B announce receipt timeout RW 3 Bits[31:4] = reserved
Bits[3:0] = number of mean announce periods before timeout occurs (value between 2 and 10 for SMPTE)
eg the timeout will be value*mean announce time

PTP Slave Port 1 Configuration : Detailed setup for both PTP mode and Timestamp processor mode.

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A008000 Mode of port operation RW 0 Bits[31:1] = Reserved.
Bits[0:0] = Mode of operation. See UG-TS2 01.
0 - PTP mode.
1 - Timestamp processor mode.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect.
0x0A008001 MODE 2: Major mode of T2 timestamp-value delivery to the TopSync slave RW 0 Bits[31:4] reserved
Bits[3:0] major timestamping mode defines how PTP packet T2 timestamp values are delivered to ToPSync.
0 - Internal - Timestamping is done locally at the ToPSync PHY.
1 - DRM - Timestamping is done remotely. Timestamps are delivered to ToPSync using Delay Replacement Messages (DRMs). The transport mechanism is defined by the minor mode.
2 - Structured in-band - Timestamping is done remotely. T2 timestamps are delivered to ToPSync by inserting the T2 timestamp as a Semtech proprietary TLV in the PTP message. The type of the TLV is defined by the minor mode.
3 - Unstructured in-band - Timestamping is done remotely. Timestamps are delivered to ToPSync by inserting the T2 timestamp at a specific location offset from the start of the PTP payload, defined by the registers 0x0A008004, through 0x0A008006. The minor mode defines the endianess and the timestamp format determines whether the second-field offset register is used.
4 - Reserved
5 - Local transparent clock - Timestamping is done remotely. See UG_TS2 01 for further information.
6-15 - Reserved

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
See also: The minor mode register (0x0A008002) and timestamp-value format (0x0A008003).
0x0A008002 MODE 2: The minor mode for T2 fills in the details of the major mode of timestamp delivery RW 0 Bits[31:4] reserved
Bits[3:0] the minor timestamping mode defines the format of T2 timestamp values delivered to ToPSync. Register value meanings depend on the major mode register 0x0A008001.

If the major mode is "1 - DRM" then valid configuration is as follows.
1 - DRMs delivered via Ethernet only. SPI DRMs will be ignored.
2 - DRMs delivered via SPI. Ethernet DRMs will be ignored.
3 - DRMS delivered via Ethernet or SPI.

If the major mode is "2 - Structure in-band" then valid configuration is as follows (see UG_TS2 01 for further information).
1 - Short TLV format is expected.
2 - Long TLV format is expected.

If the major mode is "3 - Unstructured in-band" then valid configuration is as follows.
1 - Timestamp is embedded as little endian data.
2 - Timestamp is embedded as big endian data.

For other modes, this register is not used.

Notes: If the major mode (register 0x0A008001) is set to internal, this register is not used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008003 MODE 2: Format of T2 timestamps RW 1 Bits[31:4] reserved
Bits[3:0] timestamp format. Defines whether timestamp will be nanoseconds only or full seconds and nanoseconds.
0 - sub-second timestamps (32-bit nanosecond) are expected only.
1 - full 10 octet timestamps as defined in IEEE 1588-2008 are expected (seconds and nanoseconds).
2 - timestamp will contain a nanosecond timestamp with full 32bit value range (external timestamper has free running 32bit timestamper sync'ed to seconds value of epoch)
0x0A008004 MODE 2: Offset of bits 47 to 32 of the T2 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x44 Bits [31:0] offset of the most significant 16 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0A008003 is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008005 MODE 2: Offset of bits 31 to 0 of the T2 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x46 Bits [31:0] offset of the lease significant 32 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008006 MODE 2: Offset of the T2 32-bit nanoseconds timestamp value from the start of the UDP or Ethernet payload RW 0x10 Bits [31:0] offset of the 32-bit nanosecond portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0A008003 is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008007 MODE 2: Whether egress delay request packets are timestamped RW 1 Bits[31:1] reserved
Bits[0:0] flag defines whether egress delay request packets are timestamped as they leave ToPSync or whether a user defined pattern is written into the origin timestamp field instead.
1 - the egress delay request PTP packet's origin timestamp field is filled with the packet egress time.
0 - the egress delay request PTP packet's origin timestamp field is filled with a user defined pattern (see registers 0x0A008008 through 0x0A00800A) and is not timestamped.

Notes: If the major mode (register 0x0A00800B) is set to local timestamping this register is not used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008008 MODE 2: Egress delay request timestamp-pattern seconds bits 47 to 32 RW 0 Bits[31:16] = reserved
Bits[15:0] = pattern that will be written into bits 47 to 32 of the seconds field of the egress delay request origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
Notes: This pattern is only used when egress delay request packets are NOT being timestamped.
See also: Register 0x0A008007 defining if T3 is timestamped.
0x0A008009 MODE 2: Egress delay request timestamp-pattern seconds bits 31 to 0 RW 0 Bits[31:0] pattern that will be written into bits 31 to 0 of seconds field of the egress delay request origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
Notes: This pattern is only used when egress delay request packets are NOT being timestamped.
See also: Register 0x0A008007 defining if T3 is timestamped.
0x0A00800A MODE 2: Egress delay request timestamp-pattern nanoseconds RW 0 Bits[31:0] pattern that will be written into bits 31 to 0 of the nanoseconds field of the egress delay request origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
Notes: This pattern is only used when egress delay request packets are NOT being timestamped.
See also: Register 0x0A008007 defining if T3 is timestamped.
0x0A00800B MODE 2: Major mode of T3 timestamp-value delivery to the TopSync slave RW 0 Bits[31:4] reserved
Bits[3:0] major timestamping mode defines how PTP packet T3 timestamp values are delivered to ToPSync.
0 - Internal - Timestamping is done locally at the ToPSync PHY.
1 - DRM - Timestamping is done remotely. Timestamps are delivered to ToPSync using Delay Replacement Messages (DRMs). The transport mechanism is defined by the minor mode.
2 - Structured in-band - Timestamping is done remotely. T3 timestamps are delivered to ToPSync by inserting the T3 timestamp as a Semtech proprietary TLV in the PTP message. The type of the TLV is defined by the minor mode.
3 - Unstructured in-band - Timestamping is done remotely. Timestamps are delivered to ToPSync by inserting the T3 timestamp at a specific location offset from the start of the PTP payload, defined by the registers 0x0A00800E, through 0x0A008010. The minor mode defines the endianess and the timestamp format determines whether the second-field offset register is used.
4 - Reserved
5 - Local transparent clock - Timestamping is done remotely. See UG_TS2 01 for further information.
6-15 - Reserved

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
See also: The minor mode register (0x0A00800C) and timestamp-value format (0x0A00800D).
0x0A00800C MODE 2: The minor mode for T3 fills in the details of the major mode of timestamp delivery RW 0 Bits[31:4] reserved
Bits[3:0] the minor timestamping mode defines the format of T3 timestamp values delivered to ToPSync. Register value meanings depend on the major mode register 0x0A00800B.

If the major mode is "1 - DRM" then valid configuration is as follows.
1 - DRMs delivered via Ethernet only. SPI DRMs will be ignored.
2 - DRMs delivered via SPI. Ethernet DRMs will be ignored.
3 - DRMS delivered via Ethernet or SPI.

If the major mode is "2 - Structure in-band" then valid configuration is as follows (see UG_TS2 01 for further information).
1 - Short TLV format is expected.
2 - Long TLV format is expected.

If the major mode is "3 - Unstructured in-band" then valid configuration is as follows.
1 - Timestamp is embedded as little endian data.
2 - Timestamp is embedded as big endian data.

For other modes, this register is not used.

Notes: If the major mode (register 0x0A00800B) is set to internal, this register is not used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A00800D MODE 2: Format of T3 timestamps RW 1 Bits[31:4] reserved
Bits[3:0] timestamp format. Defines whether timestamp will be nanoseconds only or full seconds and nanoseconds.
0 - sub-second timestamps (32-bit nanosecond) are expected only.
1 - full 10 octet timestamps as defined in IEEE 1588-2008 are expected (seconds and nanoseconds).
2 - timestamp will contain a nanosecond timestamp with full 32bit value range (external timestamper has free running 32bit timestamper sync'ed to seconds value of epoch)
0x0A00800E MODE 2: Offset of bits 47 to 32 of the T3 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x44 Bits [31:0] offset of the most significant 16 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0A00800D is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A00800F MODE 2: Offset of bits 31 to 0 of the T3 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x46 Bits [31:0] offset of the lease significant 32 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008010 MODE 2: Offset of the T3 32-bit nanoseconds timestamp value from the start of the UDP or Ethernet payload RW 0x10 Bits [31:0] offset of the 32-bit nanosecond portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0A00800D is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0A008000).
0x0A008011 MODE 3: Delivery method (Ethernet | SPI) RW 0 Bits[31:4] reserved
Bits[3:0] Bit mask specifiying acceptable modes of DRM delivery.
0000 - Disables DRM delivery!
0001 - Enables SPI delivery only
0010 - Enables Ethernet delivery only
0011 - Enables both SPI and Ethernet delivery.
xxxx - All other values are invalid.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if TopSync is in timestamp-processor mode (see register 0x0A008000).
Notes: Applies only to timestamp processor mode.
0x0A008012 MODE 3: Format of timestamps being delivered RW 0 Bits[31:4] reserved
Bits[3:0]
0 - 32-bit nanosecond timestamps expected.
1 - full 48-bit seconds and 32-bit nanoseconds (IEEE1588) timestamps expected.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0A000004). When the port is re-enabled the setting will take effect if TopSync is in timestamp-processor mode (see register 0x0A008000).
Notes: Applies only to timestamp processor mode.
0x0A008013 Reserved - - Reserved
0x0A008014 Reserved - - Reserved

PTP Slave Port 1 Configuration : Read only PTP slave statistics.

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A00C000 Bits 47 through 32 of seconds portion of last T1 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T1 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0A00C001 Bits 31 through 0 of seconds portion of last T1 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T1 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C002 Nanoseconds portion of last T1 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T1 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C003 Bits 47 through 32 of seconds portion of last T2 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T2 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0A00C004 Bits 31 through 0 of seconds portion of last T2 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T2 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C005 Nanoseconds portion of last T2 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T2 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C006 Bits 47 through 32 of seconds portion of last T3 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T3 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0A00C007 Bits 31 through 0 of seconds portion of last T3 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T3 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C008 Nanoseconds portion of last T3 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T3 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C009 Bits 47 through 32 of seconds portion of last T4 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T4 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0A00C00A Bits 31 through 0 of seconds portion of last T4 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T4 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C00B Nanoseconds portion of last T4 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T4 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0A00C00C Num T1 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T1 time stamps received.
0x0A00C00D Num T1 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T1 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0A00C00E Num T1 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T1 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0A00C00F Num T2 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T2 time stamps received.
0x0A00C010 Num T2 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T2 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0A00C011 Num T2 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T2 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0A00C012 Num T3 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T3 time stamps received.
0x0A00C013 Num T3 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T3 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0A00C014 Num T3 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T3 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0A00C015 Num T4 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T4 time stamps received.
0x0A00C016 Num T4 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T4 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0A00C017 Num T4 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T4 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0A00C018 Num DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.

Notes: Although this is grouped with port-specific statistics, this is not port specific and applies globally.
0x0A00C019 Num DRM messages received but dropped RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.

Notes: Although this is grouped with port-specific statistics, this is not port specific and applies globally.
0x0A00C01A Num DRMS messages received but with invalid PTP port number RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.

Notes: Although this is grouped with port-specific statistics, this is not port specific and applies globally.
0x0A00C01B Num of source-select DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: that this only applies when ToPSync is operating in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C01C Num of source-deselect DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: that this only applies when ToPSync is operating in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C01D Num of T1 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C01E Num of T1 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C01F Num of T1 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C020 Num of T1 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C021 Num of T1 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C022 Num of T2 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C023 Num of T2 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C024 Num of T2 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C025 Num of T2 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C026 Num of T2 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C027 Num of T3 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C028 Num of T3 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C029 Num of T3 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C02A Num of T3 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C02B Num of T3 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C02C Num of T4 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C02D Num of T4 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C02E Num of T4 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C02F Num of T4 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C030 Num of T4 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0A008000.
0x0A00C031 Reserved - - Reserved
0x0A00C032 Reserved - - Reserved
0x0A00C033 Reserved - - Reserved
0x0A00C034 Reserved - - Reserved
0x0A00C035 Reserved - - Reserved
0x0A00C036 Reserved - - Reserved
0x0A00C037 Reserved - - Reserved
0x0A00C038 Reserved - - Reserved
0x0A00C039 Reserved - - Reserved
0x0A00C03A Reserved - - Reserved

PTP Slave Port 1 Configuration : Subsystem to allow user defined data to be sent between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A010000 the length of time the data message is sent after which it times out RW 10 The message is sent at a rate of 4Hz until this timeout or an acknowledge is received.
Default and min value is 2s, max value is 10s
Bits[31:8] = Reserved
Bits[7:0] = time in secs
0x0A010001 Receivers Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0A010002 Receiver Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0A010003 Receiver Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0A010004 Receiver Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0A010005 Receiver Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0A010008 enable this system RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' will enable the system. This will start the timing of the system but no messages will be sent until the
data is ready to be sent
'0' disable the system.
0x0A010009 send the data RW 0 Note that this will send the data to the first configured ptp port on the same domain at the receiver end.
Bits[31:1] = Reserved
Bits[0:0] = '1' - if there is data to send then this will start sending the data in a signalling message at a rate of 4Hz.
'0' - The system will automatically clear this bit when the data has been sent.
0x0A01000A states whether sending was ok or failed RW 0 Bits[31:2] = Reserved
Bits[1:0] = If first bit is 1 then it was sent ok
If second bit is 1 then the send failed
0x0A010010 length of data to send in words RW 0 Bits[31:16] = Reserved
Bits[15:0] = Length of data. Maximum size is 64 words
This length is large enough to take gps ephemeris data
0x0A010011 first 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the last value
data word is contiguous.
0x0A010050 last possible 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the last value
data word is contiguous.

PTP Slave Port 1 Configuration : Subsystem to allow user defined data to be received between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A014000 the length of time the acknowledge message is sent before it times out RW 10 The message is sent at a rate of 4Hz until this timeout.
Default and min value is 2s, maximum value is 10
Bits[31:8] = Reserved
Bits[7:0] = timeout
0x0A014001 enable the receipt of user data RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' enable
'0' disable
0x0A014002 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0A014003 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0A014004 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0A014005 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0A014006 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0A014008 data is ready to read RW 0 The users should clear this bit after reading the data
Bits[31:1] = Reserved
Bits[0:0] = '1' data has been received and can be read
'0' no data
0x0A014009 Reserved - - Reserved
0x0A014010 length of data received in words RO 0 Bits[31:16] = Reserved
Bits[15:0] = length of data
This value can be up to 64 words
0x0A014011 first 4 bytes of data received RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous
0x0A014050 last possible 4 bytes of data received RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous

PTP Slave Port 1 Configuration : Subsystem to allow smpte data to be received between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0A018000 Default video frame rate of the slave system as a lowest term rational RO 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = numerator
0x0A018001 Default video frame rate of the slave system as a lowest term rational RO 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = denominator
0x0A018002 Complementary information to clockClass RO 0 This gives more information regarding the clock class.
Bits[31:8] = reserved
Bits[7:0] = 0: Not in use
1: Free Run
2: Cold Locking. In response to a disturbance, the grandmaster is re-locking quickly. In this situation, a rapid phase
adjustment with a time discontinuity can be expected.
3: Warm Locking. In response to a disturbance, the grandmaster is re-locking slowly by means of a frequency adjustment,
with no phase discontinuity. Time continuity is maintained.
4: Locked (i.e., in normal operation and stable)
0x0A018003 Indicates the intended SMPTE ST 12-1 flags RO 0 Bits[31:2] = reserved
Bits[1:0] = Bit 0: Drop frame
0: Non-drop-frame
1: Drop-frame
Bit 1: Color Frame Identification
0: Not in use
0x0A018004 Offset in seconds of Local Time from grandmaster PTP time RO 0 Bits[31:0] = offset in seconds
0x0A018005 The size of the next discontinuity in seconds of Local Time RO 0 Bits[31:0] = A value of zero indicates that no discontinuity is expected. A positive value indicates that the discontinuity will
cause the currentLocalOffset to increase.
0x0A018006 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RO 0 The discontinuity occurs at the start of the second indicated
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0A018007 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RO 0 The discontinuity occurs at the start of the second indicated
Bits[15:0] = reserved
Bits[31:16] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0A018008 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RO 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:16] = this is a 48 bit number where the top 32 bits are stored in this register
0x0A018009 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RO 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[15:0] = reserved
Bits[31:16] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0A01800A the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RO 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0A01800B the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RO 0 Bits[15:0] = reserved
Bits[31:16] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0A01800C The value of currentLocalOffset at the time of the previous Daily Jam event RW 0 Bits[31:0] = offset
If a discontinuity of Local Time occurs at the jam time, this parameter reflects the offset after the discontinuity
0x0A01800D indicates the daylight saving RO 0 Bits[31:3] = reserved
Bits[2:0] = Bit 0: Current Daylight Saving
0: Not in effect
1: In effect
Bit 1: Daylight Saving at next discontinuity
0: Not in effect
1: In effect
Bit 2: Daylight Saving at previous Daily Jam event
0: Not in effect
1: In effect
0x0A01800E The reason for the forthcoming discontinuity of currentLocalOffset indicated by timeOfNextJump RO 0 Bits[31:1] = reserved
Bits[0:0] = Bit 0:
0: Other than a change in the number of leap seconds (default)
1: A change in number of leap seconds
0x0A018020 the sender transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0A018021 the sender transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0A018022 the sender transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0A018023 the sender transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0A018024 the sender transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0A018025 the sender port id node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the the sender port id node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
0x0A018026 the sender port id node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the the sender port id node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
0x0A018027 the sender port id ptp port number RO 0x0 Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the the sender port id
It is recommended to set all of these three port id words in one go.
0x0A018028 whether the data is new (and hence has not been read yet) RO 0x0 Bits[31:1] = reserved
Bits[0:0] = if 0 then this data has been read
if 1 then this is new data
0x0A018029 Timeout before alarmTooFewSMTLVs gets raised RW 0x5 Bits[31:3] = reserved
Bits[2:0] = Timeout before alarmTooFewSMTLVs gets raised. value between 2s and 5s

PTP Slave Port 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x0B000000 General Parameters
0x0B004000 Generic Parameters
0x0B008000 Detailed setup for both PTP mode and Timestamp processor mode.
0x0B00C000 Read only PTP slave statistics.
0x0B010000 Subsystem to allow user defined data to be sent between devices
0x0B014000 Subsystem to allow user defined data to be received between devices
0x0B018000 Subsystem to allow smpte data to be received between devices

PTP Slave Port 2 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B000000 physical port connector RW 0 Bits[31:8] reserved
Bits[7:0] connector. The physical port that this ptp port is connected to, starting from 0.
Notes: It is recommended that the first five words, connector, protocol, version, domain and configure are set at the same time.
0x0B000001 ptp port protocol RW 0 Bits[31:2] reserved
Bits[1:0] protocol. The protocol used in the ptp port.
0 udp4,
1 ethernet,
2 udp6
0x0B000002 ptp port version RO 2 Bits[31:3] reserved
Bits[2:0] version
1 version1,
2 version2
0x0B000003 ptp port domain RW 0 Bits[31:8] reserved
Bits[7:0] domain (starting from 0)
Notes: Set the domain number of the ptp port. This can be set at the same time as configuring the ptp port.
It can also be set by itself when a ptp port has already been configured.
It will only be able to communicate with other ptp ports on the same domain.
0x0B000004 configure ptp port RW 0 Bits[31:1] reserved
Bits[0:0] configure
0 deconfigure,
1 configure
Notes: Resets the PTP port, then configures the ptp port with the settings 'physical port connector', 'ptp port protocol', 'ptp port version' and 'domain' (registers 0x0B000000 through 0x0B000003). The mode configurations will also be applied at this point (see registers 0x0B008000 through 0x0B008012). Finally the network interface is enabled and the PTP port enters the listening state.
Notes: Deconfiguring a port will also disable the port.
0x0B000005 enable ptp port RW 0 Bits[31:1] reserved
Bits[0:0] enable
0 disable,
1 enable
Enables the ptp port for use. If enabled it will allow the ptp port to begin moving through it's states and PTP traffic to flow.
Notes: A PTP port must be configured (0x0B000004) before it can be enabled or disabled. Disabling a PTP port does not deconfigure it.
0x0B000007 virtual interface number RW 0 Bits[31:3] reserved
Bits[2:0] virtual interface number
0x0B000008 multi home index of address on interface RW 0 Bits[31:4] reserved
Bits[3:0] multi home index of address on interface
0x0B000010 The node id of the ptp port bytes 0 to 3 RW 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these two node id words in one go.
0x0B000011 The node id of the ptp port bytes 4 to 7 RW 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these two node id words in one go.
0x0B000012 The default node id of the ptp port RO 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x0B000013 The default id of the ptp port RO 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x0B000014 The state of the ptp port RO 0x0 Bits[31:4] reserved
Bits[3:0] state of the ptp port
0 = portFaulty,
1 = portDisabled,
2 = portListening,
3 = portPreMaster,
4 = portMaster,
5 = portPassive,
6 = portUncalibrated,
7 = portSlave
0x0B000015 best master clock algorithm mask RW 0xBF Bits[31:8] = reserved
Bits[7:0] = mask
0x01 GM Priority1
0x02 GM Identity
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values
0x100 Local Priority
Notes: Configures which steps in the best master clock algorithm are performed.
The default value is 0xBF, ie all steps enabled except for Steps Removed and Local Priority
0x0B000016 better master available flag RO 0x0 Bits[31:1] = reserved
Bits[0:0] = flag
0 = true,
1 = false
Notes: This indicates if there is a better master available than the currently selected master.
0x0B000018 Reserved - - Reserved
0x0B000020 Reserved - - Reserved
0x0B000021 required unicast announce log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: required unicast log period of the announce message.
The desired log period is the smallest (and hence fastest rate) that is desired.
The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0B000022 required unicast announce duration RW 250 Bits[31:0] duration
Notes: Set duration of the required unicast grant duration of the announce message.
0x0B000023 desired unicast announce log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Set desired unicast log period of the announce message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0B000024 Reserved - - Reserved
0x0B000025 required unicast sync log period RW -3 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set required unicast log period of the sync message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
It is recommended to set this and the next two parameters at the same time.
0x0B000026 required unicast sync duration RW 250 Bits[31:0] duration
Notes: Set duration of the required unicast grant duration of the sync message.
0x0B000027 desired unicast sync log period RW -5 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired unicast log period of the sync message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0B000028 desired multicast delay resp log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired multicast log period of the delay resp message. The desired log period is the smallest
(and hence fastest rate) that is desired. The required log period is the largest (and hence slowest rate) that is
satisfactory to the ptp port.
This setting should only be used on a ptp port that actually provides these multicast messages.
0x0B000029 required unicast delay resp log period RW -3 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set required unicast log period of the delay resp message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
It is recommended to set this and the next two parameters at the same time.
0x0B00002A required unicast delay resp duration RW 250 Bits[31:0] duration
Notes: Set duration of the required delay resp grant duration of the sync message.
0x0B00002B desired unicast delay resp log period RW -5 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired unicast log period of the delay resp message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0B00002C Reserved - - Reserved
0x0B00002D Reserved - - Reserved
0x0B00002E Reserved - - Reserved
0x0B00002F enable DelayRequest send unicast in mluticast mode RW 0 Bits[31:1] Reserved
Bits[0] = 1 - enable, 0 - disable
Note ptp port configure will reset to 0
0x0B000050 use master to slave delays RW 0x1 Bits[31:1] reserved
Bits[0:0] m2s delay
0 = disable,
1 = enable
Notes: Configures the ptp port to use master to slave delays.
It is recommended to set this and the next parameter at the same time.
If this and the next parameter are enabled then delays in both directions will be used.
0x0B000051 use slave to master delays RW 0x1 Bits[31:1] reserved
Bits[0:0] m2s delay
0 = disable,
1 = enable
Notes: Configures the ptp port to use slave to master delays.
It is recommended to set this and the previous parameter at the same time.
If this and the previous parameter are enabled then delays in both directions will be used.
0x0B000052 number of missing announce messages RW 0x5 Bits[31:16] reserved
Bits[15:0] = number of missing announce
Notes: Configures the number of missing announce messages after which the master is considered to be lost.
0x0B000053 enabled forced master operation RW 0x0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the forced master operation. If set then the next parameter gives the visible master index of the device
to be the current master, thus overriding the usual selection method.
It is recommended to set this and the next parameter at the same time.
0x0B000054 visible master index of the forced master RW 0x0 Bits[31:8] = reserved
Bits[7:0] = index (from 0 to max number of visible masters)
Notes: Sets visible master index of the device to be the current master, thus overriding the usual selection method.
It is recommended to set this and the previous parameter at the same time.
0x0B000055 wait to restore time RW 0x0 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Set the time in seconds after which a visible master can be considered to be the current master.
0x0B000056 Enable Revertive Operation On Same Transport RW 0 Bits[31:1] Reserved
Bits[0] = 1 - Revertive operation enabled, 0 - disabled
Note this controls the revertive operation on the PTP port. There is a separate configuration
for revertive operation for Node Time inputs
0x0B000057 Reserved - - Reserved
0x0B000060 Enable protocol of G8273.2 RW 0 Bits[31:1] Reserved
Bits[0] = 1 - the protocol of G8273.2 enabled, 0 - disabled
0x0B000061 Reserved - - Reserved
0x0B000062 enable master fast switch mode RW 0 Bits[31:1] Reserved
Bits[0] = 1 - enable, 0 - disable

PTP Slave Port 2 Configuration : Generic Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B004000 addressing mode RW 0 Bits[31:2] = reserved
Bits[1:0] = addressing mode
asAppropriate = 0,
unicastOnly = 1,
multicastOnly = 2
Notes: Sets the addressing mode of the ptp port.
0x0B004001 enable path delay request messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
This enables sending of path delay request messages.
0x0B004002 master packet interface speed RW 0 Bits[31:0] = speed in bits per second
Notes: Sets the master packet interface speed in bits per second.
0x0B004003 accept ms multicast timing messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to accept master to slave multicast timing messages.
When there are no active unicast grants and this flag is true then it means the timing
situation is good. Thus the state of the visible master can be set to valid - meaning it can be used as
a master.
0x0B004004 enable ms unicast grant requests RW 1 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to make master to slave unicast grant requests. This is on by default.
If this is on and the addressing mode is not multicastOnly then this will enable grant requests to
be made.
0x0B004005 accept sm multicast timing messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to accept slave to master multicast timing messages.
When there are no active unicast grants and this flag is true then it means the timing
situation is good. Thus the state of the visible master can be set to valid - meaning it can be used as
a master.
0x0B004006 enable sm unicast grant requests RW 1 Bits[31:0] = enable
0 = disable,
1 = enable
Notes: Enables the port to make slave to master unicast grant requests. This is on by default
If this is on and the addressing mode is not multicastOnly then this will enable grant requests to
be made.
0x0B00400A enable path delay response messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: This can only be enabled when path delay requests have been disabled.
0x0B00400B path delay value RW 0 Bits[31:0] = delay as a float value
0x0B004010 enable enhanced boundary clock RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the enhanced boundary clock.
0x0B004013 Reserved - - Reserved
0x0B004014 Reserved - - Reserved
0x0B004015 Reserved - - Reserved
0x0B004016 Reserved - - Reserved
0x0B004017 Reserved - - Reserved
0x0B004018 Reserved - - Reserved
0x0B004040 announce grant request threshold RW 20 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the announce grant request threshold - this is the time remaining for a grant after which
new grant requests will be made.
0x0B004041 sync grant request threshold RW 20 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the sync grant request threshold - this is the time remaining for a grant after which
new grant requests will be made.
0x0B004042 delay grant request threshold RW 20 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the delay grant request threshold - this is the time remaining for a grant after which
new grant requests will be made.
0x0B004043 announce grant repeat period RW 2 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the announce grant repeat period - when grant requests are made they will be repeated at this interval.
0x0B004044 sync grant repeat period RW 2 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the sync grant repeat period - when grant requests are made they will be repeated at this interval.
0x0B004045 delay grant repeat period RW 2 Bits[31:16] = reserved
Bits[15:0] = time in s
Notes: Sets the delay grant repeat period - when grant requests are made they will be repeated at this interval.
0x0B004046 Reserved - - Reserved
0x0B004047 holdoff timer RW 0 Bits[31:0] = time in s, sint32
Notes: Enables the holdoff timer which is the time from when the master is not visible until when the port will
stop considering it as a use-able master. A non zero value will begin this operation.
0x0B004048 primary reference source clock stratum value RW 6 Bits[31:8] = reserved
Bits[7:0] = Clock stratum level
Notes: This value will be used when comparing the clock class on setting the Freq Traceable flag in ptp messages.
The default value is clock stratum level primaryReference (=6)
0x0B004049 network traffic load profile RW 0 Bits[31:2] = reserved
Bits[1:0] = values from below:
normalLoadTraffic = 0,
heavyLoadTraffic = 1,
0x0B00404A override frequency traceable flag RW 0 Bits[31:2] = reserved
Bits[1:1] = if '1' then use the override the frequency traceable flag in ptp messages with the value in bit0.
Bits[0:0] = if '1' then frequency traceable flag is 1
if '0' then frequency traceable flag is 0
0x0B00404B announce receipt timeout RW 3 Bits[31:4] = reserved
Bits[3:0] = number of mean announce periods before timeout occurs (value between 2 and 10 for SMPTE)
eg the timeout will be value*mean announce time

PTP Slave Port 2 Configuration : Detailed setup for both PTP mode and Timestamp processor mode.

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B008000 Mode of port operation RW 0 Bits[31:1] = Reserved.
Bits[0:0] = Mode of operation. See UG-TS2 01.
0 - PTP mode.
1 - Timestamp processor mode.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect.
0x0B008001 MODE 2: Major mode of T2 timestamp-value delivery to the TopSync slave RW 0 Bits[31:4] reserved
Bits[3:0] major timestamping mode defines how PTP packet T2 timestamp values are delivered to ToPSync.
0 - Internal - Timestamping is done locally at the ToPSync PHY.
1 - DRM - Timestamping is done remotely. Timestamps are delivered to ToPSync using Delay Replacement Messages (DRMs). The transport mechanism is defined by the minor mode.
2 - Structured in-band - Timestamping is done remotely. T2 timestamps are delivered to ToPSync by inserting the T2 timestamp as a Semtech proprietary TLV in the PTP message. The type of the TLV is defined by the minor mode.
3 - Unstructured in-band - Timestamping is done remotely. Timestamps are delivered to ToPSync by inserting the T2 timestamp at a specific location offset from the start of the PTP payload, defined by the registers 0x0B008004, through 0x0B008006. The minor mode defines the endianess and the timestamp format determines whether the second-field offset register is used.
4 - Reserved
5 - Local transparent clock - Timestamping is done remotely. See UG_TS2 01 for further information.
6-15 - Reserved

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
See also: The minor mode register (0x0B008002) and timestamp-value format (0x0B008003).
0x0B008002 MODE 2: The minor mode for T2 fills in the details of the major mode of timestamp delivery RW 0 Bits[31:4] reserved
Bits[3:0] the minor timestamping mode defines the format of T2 timestamp values delivered to ToPSync. Register value meanings depend on the major mode register 0x0B008001.

If the major mode is "1 - DRM" then valid configuration is as follows.
1 - DRMs delivered via Ethernet only. SPI DRMs will be ignored.
2 - DRMs delivered via SPI. Ethernet DRMs will be ignored.
3 - DRMS delivered via Ethernet or SPI.

If the major mode is "2 - Structure in-band" then valid configuration is as follows (see UG_TS2 01 for further information).
1 - Short TLV format is expected.
2 - Long TLV format is expected.

If the major mode is "3 - Unstructured in-band" then valid configuration is as follows.
1 - Timestamp is embedded as little endian data.
2 - Timestamp is embedded as big endian data.

For other modes, this register is not used.

Notes: If the major mode (register 0x0B008001) is set to internal, this register is not used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008003 MODE 2: Format of T2 timestamps RW 1 Bits[31:4] reserved
Bits[3:0] timestamp format. Defines whether timestamp will be nanoseconds only or full seconds and nanoseconds.
0 - sub-second timestamps (32-bit nanosecond) are expected only.
1 - full 10 octet timestamps as defined in IEEE 1588-2008 are expected (seconds and nanoseconds).
2 - timestamp will contain a nanosecond timestamp with full 32bit value range (external timestamper has free running 32bit timestamper sync'ed to seconds value of epoch)
0x0B008004 MODE 2: Offset of bits 47 to 32 of the T2 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x44 Bits [31:0] offset of the most significant 16 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0B008003 is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008005 MODE 2: Offset of bits 31 to 0 of the T2 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x46 Bits [31:0] offset of the lease significant 32 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008006 MODE 2: Offset of the T2 32-bit nanoseconds timestamp value from the start of the UDP or Ethernet payload RW 0x10 Bits [31:0] offset of the 32-bit nanosecond portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0B008003 is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008007 MODE 2: Whether egress delay request packets are timestamped RW 1 Bits[31:1] reserved
Bits[0:0] flag defines whether egress delay request packets are timestamped as they leave ToPSync or whether a user defined pattern is written into the origin timestamp field instead.
1 - the egress delay request PTP packet's origin timestamp field is filled with the packet egress time.
0 - the egress delay request PTP packet's origin timestamp field is filled with a user defined pattern (see registers 0x0B008008 through 0x0B00800A) and is not timestamped.

Notes: If the major mode (register 0x0B00800B) is set to local timestamping this register is not used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008008 MODE 2: Egress delay request timestamp-pattern seconds bits 47 to 32 RW 0 Bits[31:16] = reserved
Bits[15:0] = pattern that will be written into bits 47 to 32 of the seconds field of the egress delay request origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
Notes: This pattern is only used when egress delay request packets are NOT being timestamped.
See also: Register 0x0B008007 defining if T3 is timestamped.
0x0B008009 MODE 2: Egress delay request timestamp-pattern seconds bits 31 to 0 RW 0 Bits[31:0] pattern that will be written into bits 31 to 0 of seconds field of the egress delay request origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
Notes: This pattern is only used when egress delay request packets are NOT being timestamped.
See also: Register 0x0B008007 defining if T3 is timestamped.
0x0B00800A MODE 2: Egress delay request timestamp-pattern nanoseconds RW 0 Bits[31:0] pattern that will be written into bits 31 to 0 of the nanoseconds field of the egress delay request origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
Notes: This pattern is only used when egress delay request packets are NOT being timestamped.
See also: Register 0x0B008007 defining if T3 is timestamped.
0x0B00800B MODE 2: Major mode of T3 timestamp-value delivery to the TopSync slave RW 0 Bits[31:4] reserved
Bits[3:0] major timestamping mode defines how PTP packet T3 timestamp values are delivered to ToPSync.
0 - Internal - Timestamping is done locally at the ToPSync PHY.
1 - DRM - Timestamping is done remotely. Timestamps are delivered to ToPSync using Delay Replacement Messages (DRMs). The transport mechanism is defined by the minor mode.
2 - Structured in-band - Timestamping is done remotely. T3 timestamps are delivered to ToPSync by inserting the T3 timestamp as a Semtech proprietary TLV in the PTP message. The type of the TLV is defined by the minor mode.
3 - Unstructured in-band - Timestamping is done remotely. Timestamps are delivered to ToPSync by inserting the T3 timestamp at a specific location offset from the start of the PTP payload, defined by the registers 0x0B00800E, through 0x0B008010. The minor mode defines the endianess and the timestamp format determines whether the second-field offset register is used.
4 - Reserved
5 - Local transparent clock - Timestamping is done remotely. See UG_TS2 01 for further information.
6-15 - Reserved

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
See also: The minor mode register (0x0B00800C) and timestamp-value format (0x0B00800D).
0x0B00800C MODE 2: The minor mode for T3 fills in the details of the major mode of timestamp delivery RW 0 Bits[31:4] reserved
Bits[3:0] the minor timestamping mode defines the format of T3 timestamp values delivered to ToPSync. Register value meanings depend on the major mode register 0x0B00800B.

If the major mode is "1 - DRM" then valid configuration is as follows.
1 - DRMs delivered via Ethernet only. SPI DRMs will be ignored.
2 - DRMs delivered via SPI. Ethernet DRMs will be ignored.
3 - DRMS delivered via Ethernet or SPI.

If the major mode is "2 - Structure in-band" then valid configuration is as follows (see UG_TS2 01 for further information).
1 - Short TLV format is expected.
2 - Long TLV format is expected.

If the major mode is "3 - Unstructured in-band" then valid configuration is as follows.
1 - Timestamp is embedded as little endian data.
2 - Timestamp is embedded as big endian data.

For other modes, this register is not used.

Notes: If the major mode (register 0x0B00800B) is set to internal, this register is not used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B00800D MODE 2: Format of T3 timestamps RW 1 Bits[31:4] reserved
Bits[3:0] timestamp format. Defines whether timestamp will be nanoseconds only or full seconds and nanoseconds.
0 - sub-second timestamps (32-bit nanosecond) are expected only.
1 - full 10 octet timestamps as defined in IEEE 1588-2008 are expected (seconds and nanoseconds).
2 - timestamp will contain a nanosecond timestamp with full 32bit value range (external timestamper has free running 32bit timestamper sync'ed to seconds value of epoch)
0x0B00800E MODE 2: Offset of bits 47 to 32 of the T3 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x44 Bits [31:0] offset of the most significant 16 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0B00800D is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B00800F MODE 2: Offset of bits 31 to 0 of the T3 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x46 Bits [31:0] offset of the lease significant 32 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008010 MODE 2: Offset of the T3 32-bit nanoseconds timestamp value from the start of the UDP or Ethernet payload RW 0x10 Bits [31:0] offset of the 32-bit nanosecond portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0B00800D is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if the port is in PTP mode (see register 0x0B008000).
0x0B008011 MODE 3: Delivery method (Ethernet | SPI) RW 0 Bits[31:4] reserved
Bits[3:0] Bit mask specifiying acceptable modes of DRM delivery.
0000 - Disables DRM delivery!
0001 - Enables SPI delivery only
0010 - Enables Ethernet delivery only
0011 - Enables both SPI and Ethernet delivery.
xxxx - All other values are invalid.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if TopSync is in timestamp-processor mode (see register 0x0B008000).
Notes: Applies only to timestamp processor mode.
0x0B008012 MODE 3: Format of timestamps being delivered RW 0 Bits[31:4] reserved
Bits[3:0]
0 - 32-bit nanosecond timestamps expected.
1 - full 48-bit seconds and 32-bit nanoseconds (IEEE1588) timestamps expected.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0B000004). When the port is re-enabled the setting will take effect if TopSync is in timestamp-processor mode (see register 0x0B008000).
Notes: Applies only to timestamp processor mode.
0x0B008013 Reserved - - Reserved
0x0B008014 Reserved - - Reserved

PTP Slave Port 2 Configuration : Read only PTP slave statistics.

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B00C000 Bits 47 through 32 of seconds portion of last T1 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T1 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0B00C001 Bits 31 through 0 of seconds portion of last T1 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T1 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C002 Nanoseconds portion of last T1 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T1 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C003 Bits 47 through 32 of seconds portion of last T2 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T2 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0B00C004 Bits 31 through 0 of seconds portion of last T2 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T2 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C005 Nanoseconds portion of last T2 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T2 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C006 Bits 47 through 32 of seconds portion of last T3 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T3 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0B00C007 Bits 31 through 0 of seconds portion of last T3 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T3 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C008 Nanoseconds portion of last T3 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T3 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C009 Bits 47 through 32 of seconds portion of last T4 time stamp seen RO 0 Bits[31:16] reserved
Bits[15:0] bits 47 to 32 of the 48-bit seconds field in the last IEEE T4 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)

Notes: This is just a snapshot of the last time stamp seen when this API call was serviced. If read in a block it is not guaranteed that timestamps are paired. For example, if T1|3 and T2|4 timestamps are read, the two may be from packets with different sequence id's... they are just the last seen.
0x0B00C00A Bits 31 through 0 of seconds portion of last T4 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the 48-bit seconds field in the last IEEE T4 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C00B Nanoseconds portion of last T4 time stamp seen RO 0 Bits[31:0] bits 31 to 0 of the nanoseconds field in the last IEEE T4 time stamp received (via normal PTP flow or mode 2 time stamp replacement methods)
0x0B00C00C Num T1 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T1 time stamps received.
0x0B00C00D Num T1 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T1 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0B00C00E Num T1 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T1 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0B00C00F Num T2 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T2 time stamps received.
0x0B00C010 Num T2 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T2 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0B00C011 Num T2 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T2 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0B00C012 Num T3 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T3 time stamps received.
0x0B00C013 Num T3 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T3 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0B00C014 Num T3 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T3 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0B00C015 Num T4 valid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T4 time stamps received.
0x0B00C016 Num T4 invalid RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of invalid T4 time stamps received. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.
0x0B00C017 Num T4 valid but dropped RO 0 Bits[31:0] a rolling 32-bit counter indicating the number of valid T4 time stamps received that were not used because their pair time stamp was not seen (in time). For example, a T1 time stamp could be received, but if the corresponding T2 was never delivered by the remote time stamping PHY then the T1 would be dropped.
0x0B00C018 Num DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.

Notes: Although this is grouped with port-specific statistics, this is not port specific and applies globally.
0x0B00C019 Num DRM messages received but dropped RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.

Notes: Although this is grouped with port-specific statistics, this is not port specific and applies globally.
0x0B00C01A Num DRMS messages received but with invalid PTP port number RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.

Notes: Although this is grouped with port-specific statistics, this is not port specific and applies globally.
0x0B00C01B Num of source-select DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: that this only applies when ToPSync is operating in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C01C Num of source-deselect DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: that this only applies when ToPSync is operating in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C01D Num of T1 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C01E Num of T1 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C01F Num of T1 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C020 Num of T1 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C021 Num of T1 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C022 Num of T2 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C023 Num of T2 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C024 Num of T2 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C025 Num of T2 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C026 Num of T2 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C027 Num of T3 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C028 Num of T3 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C029 Num of T3 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C02A Num of T3 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C02B Num of T3 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C02C Num of T4 DRM messages received RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C02D Num of T4 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C02E Num of T4 DRM messages received but deemed invalid due to a bad timestamp value RO 0 Bits[31:0] a rolling 32-bit counter. An invalid time stamp is one that does not conform to the IEEE1588 specification or contains unintelligible data.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C02F Num of T4 DRM messages received but deemed invalid RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C030 Num of T4 DRM messages received but with an invalid minor mode RO 0 Bits[31:0] a rolling 32-bit counter.

Notes: This is DRM specific so will only apply in either PTP mode, using DRMs for remote timestamp delivery, or when in timestamp processor mode. The ToPSync mode of operation can be read from register 0x0B008000.
0x0B00C031 Reserved - - Reserved
0x0B00C032 Reserved - - Reserved
0x0B00C033 Reserved - - Reserved
0x0B00C034 Reserved - - Reserved
0x0B00C035 Reserved - - Reserved
0x0B00C036 Reserved - - Reserved
0x0B00C037 Reserved - - Reserved
0x0B00C038 Reserved - - Reserved
0x0B00C039 Reserved - - Reserved
0x0B00C03A Reserved - - Reserved

PTP Slave Port 2 Configuration : Subsystem to allow user defined data to be sent between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B010000 the length of time the data message is sent after which it times out RW 10 The message is sent at a rate of 4Hz until this timeout or an acknowledge is received.
Default and min value is 2s, max value is 10s
Bits[31:8] = Reserved
Bits[7:0] = time in secs
0x0B010001 Receivers Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0B010002 Receiver Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0B010003 Receiver Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0B010004 Receiver Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0B010005 Receiver Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0B010008 enable this system RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' will enable the system. This will start the timing of the system but no messages will be sent until the
data is ready to be sent
'0' disable the system.
0x0B010009 send the data RW 0 Note that this will send the data to the first configured ptp port on the same domain at the receiver end.
Bits[31:1] = Reserved
Bits[0:0] = '1' - if there is data to send then this will start sending the data in a signalling message at a rate of 4Hz.
'0' - The system will automatically clear this bit when the data has been sent.
0x0B01000A states whether sending was ok or failed RW 0 Bits[31:2] = Reserved
Bits[1:0] = If first bit is 1 then it was sent ok
If second bit is 1 then the send failed
0x0B010010 length of data to send in words RW 0 Bits[31:16] = Reserved
Bits[15:0] = Length of data. Maximum size is 64 words
This length is large enough to take gps ephemeris data
0x0B010011 first 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the last value
data word is contiguous.
0x0B010050 last possible 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the last value
data word is contiguous.

PTP Slave Port 2 Configuration : Subsystem to allow user defined data to be received between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B014000 the length of time the acknowledge message is sent before it times out RW 10 The message is sent at a rate of 4Hz until this timeout.
Default and min value is 2s, maximum value is 10
Bits[31:8] = Reserved
Bits[7:0] = timeout
0x0B014001 enable the receipt of user data RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' enable
'0' disable
0x0B014002 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0B014003 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0B014004 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0B014005 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0B014006 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0B014008 data is ready to read RW 0 The users should clear this bit after reading the data
Bits[31:1] = Reserved
Bits[0:0] = '1' data has been received and can be read
'0' no data
0x0B014009 Reserved - - Reserved
0x0B014010 length of data received in words RO 0 Bits[31:16] = Reserved
Bits[15:0] = length of data
This value can be up to 64 words
0x0B014011 first 4 bytes of data received RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous
0x0B014050 last possible 4 bytes of data received RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous

PTP Slave Port 2 Configuration : Subsystem to allow smpte data to be received between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0B018000 Default video frame rate of the slave system as a lowest term rational RO 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = numerator
0x0B018001 Default video frame rate of the slave system as a lowest term rational RO 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = denominator
0x0B018002 Complementary information to clockClass RO 0 This gives more information regarding the clock class.
Bits[31:8] = reserved
Bits[7:0] = 0: Not in use
1: Free Run
2: Cold Locking. In response to a disturbance, the grandmaster is re-locking quickly. In this situation, a rapid phase
adjustment with a time discontinuity can be expected.
3: Warm Locking. In response to a disturbance, the grandmaster is re-locking slowly by means of a frequency adjustment,
with no phase discontinuity. Time continuity is maintained.
4: Locked (i.e., in normal operation and stable)
0x0B018003 Indicates the intended SMPTE ST 12-1 flags RO 0 Bits[31:2] = reserved
Bits[1:0] = Bit 0: Drop frame
0: Non-drop-frame
1: Drop-frame
Bit 1: Color Frame Identification
0: Not in use
0x0B018004 Offset in seconds of Local Time from grandmaster PTP time RO 0 Bits[31:0] = offset in seconds
0x0B018005 The size of the next discontinuity in seconds of Local Time RO 0 Bits[31:0] = A value of zero indicates that no discontinuity is expected. A positive value indicates that the discontinuity will
cause the currentLocalOffset to increase.
0x0B018006 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RO 0 The discontinuity occurs at the start of the second indicated
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0B018007 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RO 0 The discontinuity occurs at the start of the second indicated
Bits[15:0] = reserved
Bits[31:16] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0B018008 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RO 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:16] = this is a 48 bit number where the top 32 bits are stored in this register
0x0B018009 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RO 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[15:0] = reserved
Bits[31:16] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0B01800A the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RO 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0B01800B the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RO 0 Bits[15:0] = reserved
Bits[31:16] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0B01800C The value of currentLocalOffset at the time of the previous Daily Jam event RW 0 Bits[31:0] = offset
If a discontinuity of Local Time occurs at the jam time, this parameter reflects the offset after the discontinuity
0x0B01800D indicates the daylight saving RO 0 Bits[31:3] = reserved
Bits[2:0] = Bit 0: Current Daylight Saving
0: Not in effect
1: In effect
Bit 1: Daylight Saving at next discontinuity
0: Not in effect
1: In effect
Bit 2: Daylight Saving at previous Daily Jam event
0: Not in effect
1: In effect
0x0B01800E The reason for the forthcoming discontinuity of currentLocalOffset indicated by timeOfNextJump RO 0 Bits[31:1] = reserved
Bits[0:0] = Bit 0:
0: Other than a change in the number of leap seconds (default)
1: A change in number of leap seconds
0x0B018020 the sender transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0B018021 the sender transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0B018022 the sender transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0B018023 the sender transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0B018024 the sender transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0B018025 the sender port id node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the the sender port id node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
0x0B018026 the sender port id node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the the sender port id node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
0x0B018027 the sender port id ptp port number RO 0x0 Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the the sender port id
It is recommended to set all of these three port id words in one go.
0x0B018028 whether the data is new (and hence has not been read yet) RO 0x0 Bits[31:1] = reserved
Bits[0:0] = if 0 then this data has been read
if 1 then this is new data
0x0B018029 Timeout before alarmTooFewSMTLVs gets raised RW 0x5 Bits[31:3] = reserved
Bits[2:0] = Timeout before alarmTooFewSMTLVs gets raised. value between 2s and 5s

PTP Master Port 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x0C000000 General Parameters
0x0C004000 Generic Parameters
0x0C008000 Grant configuration details
0x0C00C000 Details of all the announce grants, up to 1024 of these
0x0C010000 Details of all the sync grants, up to 1024 of these
0x0C014000 Details of all the delay resp grants, up to 1024 of these
0x0C018000 Detailed setup of PTP mode
0x0C01C000 Subsystem to allow user defined data to be sent between devices, eg GPS data
0x0C020000 Subsystem to allow user defined data to be received between devices, eg GPS data
0x0C024000 Send smpte data between devices

PTP Master Port 1 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C000000 physical port connector RW 0 Bits[31:8] reserved
Bits[7:0] connector. The physical port that this ptp port is connected to, starting from 0.
Notes: It is recommended that the first five words, connector, protocol, version, domain and configure are set at the same time.
0x0C000001 ptp port protocol RW 0 Bits[31:2] reserved
Bits[1:0] protocol. The protocol used in the ptp port.
0 udp4,
1 ethernet,
2 udp6
0x0C000002 ptp port version RO 2 Bits[31:3] reserved
Bits[2:0] version
1 version1,
2 version2
0x0C000003 ptp port domain RW 0 Bits[31:8] reserved
Bits[7:0] domain (starting from 0)
Notes: Set the domain number of the ptp port. This can be set at the same time as configuring the ptp port.
It can also be set by itself when a ptp port has already been configured.
It will only be able to communicate with other ptp ports on the same domain.
0x0C000004 configure ptp port RW 0 Bits[31:1] reserved
Bits[0:0] configure
0 deconfigure,
1 configure
Notes: Configures the ptp port with the settings physical port connector, ptp port protocol, ptp port version and domain.
This will also bring the ptp port up to its initial values and start up the network interface
0x0C000005 enable ptp port RW 0 Bits[31:1] reserved
Bits[0:0] enable
0 disable,
1 enable
Notes: Enable the ptp port for use. If enabled it will allow the ptp port to begin moving through its states
0x0C000006 Timebase used for port master operations RW 4 Bits[31:3] = Reserved
Bits[2:0] = Source
Valid bit (decimal) values:
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x0C000007 virtual interface number RW 0 Bits[31:3] reserved
Bits[2:0] virtual interface number
0x0C000008 multi home index of address on interface RW 0 Bits[31:4] reserved
Bits[3:0] multi home index of address on interface
0x0C000010 The node id of the ptp port bytes 0 to 3 RW 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these two node id words in one go.
0x0C000011 The node id of the ptp port bytes 4 to 7 RW 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these two node id words in one go.
0x0C000012 The default node id of the ptp port RO 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x0C000013 The default id of the ptp port RO 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x0C000014 The state of the ptp port RO 0x0 Bits[31:4] reserved
Bits[3:0] state of the ptp port
0 = portFaulty,
1 = portDisabled,
2 = portListening,
3 = portPreMaster,
4 = portMaster,
5 = portPassive,
6 = portUncalibrated,
7 = portSlave
0x0C000015 best master clock algorithm mask RW 0xBE Bits[31:8] = reserved
Bits[7:0] = mask
0x01 GM Priority1
0x02 GM Identity
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values
Notes: Configures which steps in the best master clock algorithm are performed.
The default value is 0xBF, ie all steps enabled except for Steps Removed and Priority1
0x0C000016 better master available flag RO 0x0 Bits[31:1] = reserved
Bits[0:0] = flag
0 = true,
1 = false
Notes: This indicates if there is a better master available than the currently selected master.
0x0C000017 Reserved - - Reserved
0x0C000020 desired multicast announce log period RW 1 Bits[31:8] reserved
Bits[7:0] log period log base 2 as an sint8 (value can go from 6 to -4)
Notes: The desired multicast log period of the announce message.
The desired log period is the smallest (and hence fastest rate) that is desired.
The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0C000021 Reserved - - Reserved
0x0C000022 Reserved - - Reserved
0x0C000023 Reserved - - Reserved
0x0C000024 desired multicast sync log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired multicast log period of the sync message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0C000025 Reserved - - Reserved
0x0C000026 Reserved - - Reserved
0x0C000027 Reserved - - Reserved
0x0C000028 desired multicast delay resp log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired multicast log period of the delay resp message. The desired log period is the smallest
(and hence fastest rate) that is desired. The required log period is the largest (and hence slowest rate) that is
satisfactory to the ptp port.
0x0C000029 Reserved - - Reserved
0x0C00002A Reserved - - Reserved
0x0C00002B Reserved - - Reserved
0x0C00002D Reserved - - Reserved
0x0C000050 enable/disable sending multicast announce messages RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable sending multicast announce messages
0 = disable sending multicast announce messages
Notes: ToPSync will not sent multicast announce messages when the PTP port address mode is unicastOnly.
0x0C000051 enable/disable sending multicast sync messages RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable sending multicast sync messages
0 = disable sending multicast sync messages
Notes: ToPSync will not send multicast sync messages when the PTP port addressing mode is unicastOnly.
0x0C000055 accept announce unicast grant requests RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = accept announce unicast grant requests
0 = drop announce unicast grant requests
Notes: ToPSync will drop unicast grant requests when the PTP port address mode is multicastOnly.
0x0C000056 accept sync unicast grant requests RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = accept sync unicast grant requests
0 = drop sync unicast grant requests
Notes: ToPSync will drop unicast grant requests when the PTP port address mode is multicastOnly.
0x0C000057 accept delay response unicast grant requests RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = accept delay response unicast grant requests
0 = drop delay response unicast grant requests
Notes: ToPSync will drop unicast grant requests when the PTP port address mode is multicastOnly.

PTP Master Port 1 Configuration : Generic Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C004000 addressing mode RW 0 Bits[31:2] = reserved
Bits[1:0] = addressing mode
asAppropriate = 0,
unicastOnly = 1,
multicastOnly = 2
Notes: Sets the addressing mode of the ptp port.
0x0C004001 enable path delay messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
This enables sending of path delay request messages.
0x0C004002 Reserved - - Reserved
0x0C004003 Reserved - - Reserved
0x0C004004 Reserved - - Reserved
0x0C004005 Reserved - - Reserved
0x0C004006 Reserved - - Reserved
0x0C00400A enable path delay response messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: This can only be enabled when path delay requests have been disabled.
0x0C00400B path delay value RW 0 Bits[31:0] = delay as a float value
0x0C004010 enable enhanced boundary clock RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the enhanced boundary clock.
0x0C004011 Reserved - - Reserved
0x0C004012 Reserved - - Reserved
0x0C004060 two step operation RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
0x0C004061 number of alternate masters RW 0 Sets the number of alternate masters. If greater than zero then the number of masters operational on this domain
will be this value + 1.
Bits[31:8] = reserved
Bits[7:0] = number (from 0)
0x0C004062 Reserved - - Reserved
0x0C004063 master renewal flag RW 1 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Sets the master renewal flag. If TRUE then this means the master is likely to renew new grant requests
0x0C004064 master refusal flag RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Sets the master refusal flag. If the master is unable to grant a requested rate then if this flag is set it will
refuse the grant request rather than offer a lower rate.
0x0C004065 not become master if tai unknown RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: If this is set then the ptp port will only become a master if TAI is known
0x0C004066 not become master if utc unknown RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: If this is set then the ptp port will only become a master if UTC is known
0x0C004067 not become master if not prs RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: If this is set then the ptp port will only become a master if the source is a primary reference source
0x0C004068 primary reference source clock stratum value RW 6 Bits[31:8] = reserved
Bits[7:0] = Clock stratum level
Notes: This value will be used when comparing the clock class on setting the Freq Traceable flag in ptp messages.
The default value is clock stratum level primaryReference (=6)
0x0C004069 override frequency traceable flag RW 0 Bits[31:2] = reserved
Bits[1:1] = if '1' then use the override the frequency traceable flag in ptp messages with the value in bit0.
Bits[0:0] = if '1' then frequency traceable flag is 1
if '0' then frequency traceable flag is 0
0x0C00406A always respond to unicast delay requests RW 0 Bits[31:1] = reserved
Bits[0:0] = if '1' then unicast delay requests are always responded to with unicast delay response
if '0' then the behaviour is as per the ptp port unicast/multicast/asAppropriate setting
Notes: Normally a unicast delay response is responded to only if the ptp port is unicast and the grant mechanism is used.
A unicast delay request would also be responded to if the Forced Grant Mechanism in the AMT and AST has been configured.
This 'always respond to unicast delay request' setting is used for the case where the ptp master is multicast and no grants
have been set up and no Forced Grant mechanism has been used.
In this mode no checks are made as to the ability of the port to be provide the responses at the rate coming in so this
is to be sparingly.
0x0C00406B Reserved - - Reserved
0x0C00406C override announce GM_ID high 32 bit RW 0 Bits[31:0] = grandmaster id
Notes: This value will be used to override the grandmaster id in announce messages.
0x0C00406D override announce GM_ID low 32 bit RW 0 Bits[31:0] = grandmaster id
Notes: This value will be used to override the grandmaster id in announce messages.
0x0C00406E override announce grandmaster id enable RW 0 Bits[31:1] = reserved
Bits[0:0] = if '0' then disable override GM_ID high and low to announce.
if '1' then enable override GM_ID high and low to announce.

PTP Master Port 1 Configuration : Grant configuration details

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C008000 max number of slaves RW 1024 Bits[31:16] reserved
Bits[15:0] max number.
Notes: This is the number of slaves to produce grants for, eg with the default values there can be
up to 10 1024 announce grants, 1024 sync grants and 1024 delay resp grants
0x0C008001 max total announce rate RW 512 Bits[31:0] max rate.
Notes: This is the maximum total announce rate. The summation of all the announce rates on this master cannot
exceed this value.
0x0C008002 max total sync rate RW 8192 Bits[31:0] max rate.
Notes: This is the maximum total sync rate . The summation of all the sync rates on this master cannot
exceed this value.
0x0C008003 max total delay resp rate RW 8192 Bits[31:0] max rate.
Notes: This is the maximum total delay response rate. The summation of all the delay resp rates on this master cannot
exceed this value.
0x0C008004 min announce log period RW -4 Bits[31:8] reserved
Bits[7:0] Min log period base 2 as sint8
Notes: This is the minimum announce log period for a grant.
0x0C008005 min sync log period RW -7 Bits[31:8] reserved
Bits[7:0] Min log period base 2 as sint8
Notes: This is the minimum sync log period for a grant.
0x0C008006 min delay response log period RW -7 Bits[31:8] reserved
Bits[7:0] Min log period base 2 as sint8
Notes: This is the minimum delay response log period for a grant.
0x0C008007 max announce duration RW 300 Bits[31:0] max duration.
Notes: This is the maximum duration of an announce grant.
0x0C008008 max sync duration RW 300 Bits[31:0] max duration.
Notes: This is the maximum duration of a sync grant.
0x0C008009 max delay response duration RW 300 Bits[31:0] max duration.
Notes: This is the maximum duration of a delay response grant.
0x0C00800A number of announce grants issued RO 0 Bits[31:0] number.
Notes: This is the number of announce grants that are currently issued
0x0C00800B number of sync grants issued RO 0 Bits[31:0] number.
Notes: This is the number of sync grants that are currently issued
0x0C00800C number of delay resp grants issued RO 0 Bits[31:0] number.
Notes: This is the number of delay response grants that are currently issued
0x0C00800D announce grant change counter RO 0 Bits[31:0] number.
Notes: This value increments every time an announce grant is renewed or created. This should be called
periodically and if it has changed then the user can obtain new information on the grants issued.
0x0C00800E sync grant change counter RO 0 Bits[31:0] number.
Notes: This value increments every time a sync grant is renewed or created. This should be called
periodically and if it has changed then the user can obtain new information on the grants issued.
0x0C00800F delay response grant change counter RO 0 Bits[31:0] number.
Notes: This value increments every time a delay response grant is renewed or created. This should be called
periodically and if it has changed then the user can obtain new information on the grants issued.
0x0C008010 Reserved - - Reserved
0x0C008011 Reserved - - Reserved
0x0C008012 Reserved - - Reserved
0x0C008013 Reserved - - Reserved
0x0C008014 Reserved - - Reserved
0x0C008015 Reserved - - Reserved
0x0C008016 Reserved - - Reserved
0x0C008017 Reserved - - Reserved

PTP Master Port 1 Configuration : Details of all the announce grants, up to 1024 of these

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C00C000 grant 1 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C001 grant 1 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C002 grant 1 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C003 grant 1 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C004 grant 1 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C005 grant 1 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C006 grant 1 announce log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C007 grant 1 announce duration RO 0 Bits[31:0] = announce grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C00A grant 2 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C00B grant 2 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C00C grant 2 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C00D grant 2 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C00E grant 2 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C00F grant 2 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C010 grant 2 announce log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00C011 grant 2 announce duration RO 0 Bits[31:0] = announce grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7F6 grant 1024 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7F7 grant 1024 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7F8 grant 1024 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7F9 grant 1024 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7FA grant 1024 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7FB grant 1024 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7FC grant 1024 announce log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7FD grant 1024 announce duration RO 0 Bits[31:0] = announce grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C00E7FE Reserved - - Reserved

PTP Master Port 1 Configuration : Details of all the sync grants, up to 1024 of these

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C010000 grant 1 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010001 grant 1 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010002 grant 1 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010003 grant 1 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010004 grant 1 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010005 grant 1 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010006 grant 1 sync log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010007 grant 1 sync duration RO 0 Bits[31:0] = sync grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01000A grant 2 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01000B grant 2 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01000C grant 2 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01000D grant 2 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01000E grant 2 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01000F grant 2 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010010 grant 2 sync log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C010011 grant 2 sync duration RO 0 Bits[31:0] = sync grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127F6 grant 1024 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127F7 grant 1024 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127F8 grant 1024 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127F9 grant 1024 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127FA grant 1024 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127FB grant 1024 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127FC grant 1024 sync log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127FD grant 1024 sync duration RO 0 Bits[31:0] = sync grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0127FE Reserved - - Reserved

PTP Master Port 1 Configuration : Details of all the delay resp grants, up to 1024 of these

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C014000 grant 1 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014001 grant 1 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014002 grant 1 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014003 grant 1 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014004 grant 1 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014005 grant 1 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014006 grant 1 delay response log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014007 grant 1 delay response duration RO 0 Bits[31:0] = delay response grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014008 Reserved - - Reserved
0x0C01400A grant 2 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01400B grant 2 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01400C grant 2 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01400D grant 2 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01400E grant 2 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C01400F grant 2 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014010 grant 2 delay response log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C014011 grant 2 delay response duration RO 0 Bits[31:0] = delay response grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167F6 grant 1024 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167F7 grant 1024 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167F8 grant 1024 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167F9 grant 1024 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167FA grant 1024 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167FB grant 1024 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167FC grant 1024 delay response log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C0167FD grant 1024 delay response duration RO 0 Bits[31:0] = delay response grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0C016800 Reserved - - Reserved
0x0C016801 Reserved - - Reserved
0x0C016802 Reserved - - Reserved

PTP Master Port 1 Configuration : Detailed setup of PTP mode

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C018000 Reserved - - Reserved
0x0C018001 Reserved - - Reserved
0x0C018002 Reserved - - Reserved
0x0C018003 Reserved - - Reserved
0x0C018004 Whether egress sync packets are timestamped RW 1 Bits[31:1] reserved
Bits[0:0] flag defining whether sync PTP packets are timestamped as they leave ToPSync or whether a user defined pattern is written into the origin timestamp field instead.
1 - the sync PTP packet's origin timestamp field is filled with the packet egress time (default)
0 - the sync PTP packet's origin timestamp field is filled with a user defined pattern (see registers 0x0C018005-0x0C018007) and is not timestamped.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
0x0C018005 Egress sync timestamp-pattern seconds bits 47 to 32 RW 0 Bits[31:16] = reserved
Bits[31:0] = pattern that will be written into seconds bits 47 to 32 of the egress sync origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
Notes: This pattern is only used when egress sync packets are NOT being timestamped.
See also: Register 0x0C018004.
0x0C018006 Egress sync timestamp-pattern seconds bits 31 to 0 RW 0 Bits[31:0] = pattern that will be written into seconds bits 31 to 0 of the egress sync origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
Notes: This pattern is only used when egress sync packets are NOT being timestamped.
See also: Register 0x0C018004.
0x0C018007 Egress sync timestamp-pattern nanoseconds RW 0 Bits[31:0] = pattern that will be written into nanoseconds bits 31 to 0 of the egress sync origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
Notes: This pattern is only used when egress sync packets are NOT being timestamped.
See also: register 0x0C018004.
0x0C018008 Major mode (general mode) of T4 delivery from remote PHY to ToPSync master RW 0 Bits[31:4] reserved
Bits[3:0] major timestamping mode defining how PTP packet T4 timestamp values are delivered to ToPSync.
0 - Normal - For sync packets this implies that the remote PHY is one step. Whether the egress sync is timestamped depends on the register 0x0C018004. For delay request packets this implies that the packet is timestamped locally on ingress to TopSync.
1 - Reserved
2 - TLV - Only applies to ingress delay request packets. The PHY has timestamped the ingress time and appended it to the delay request as a Semtech proprietary TLV.
3 - Embedded - Only applies to ingress delay request packets. The PHY has timestamped the ingress time and embedded the timestamp in the Ethernet packet.
4 - Reserved
5 - Correction field adjustment - For sync packets this may or may not mean that the packet is timestamped as it leaves TopSync. For delay request packets, it means that the ingress delay request packet is timestamped locally and the remote PHY has also adjusted the packet's CF as described in UG-TS2 01.
6-15 - Reserved

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
0x0C018009 Detailed description of the general mode of timestamp delivery RW 0 Bits[31:4] reserved
Bits[3:0] minor timestamping mode defining the format of the timestamp information delivered back to ToPSync. Register value meanings depend on register setting of 0x0C018008. If the major mode (register 0x0C018008) is "0 - normal" then this register is ignored.

If the major mode is "1 - DRM" then valid configuration is as follows.
1 - DRMs delivered via Ethernet only. SPI DRMs will be ignored.
2 - DRMs delivered via SPI. Ethernet DRMs will be ignored.
3 - DRMS delivered via Ethernet or SPI.

If the major mode is "2- TLV" then valid configuration is as follows.
1 - Short TLV format is expected.
2 - Long TLV format is expected.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
0x0C01800A Format of t4 timestamps RW 1 Bits[31:4] reserved
Bits[3:0] timestamp format. Defines whether timestamp will be nanoseconds only or full seconds and nanoseconds. If the major mode (register 0x0C018008) is "0 - normal" then this register is ignored.
0 - 32-bit nanosecond timestamps expected.
1 - full 48-bit seconds and 32-bit nanoseconds (IEEE1588) timestamps expected.
2 - timestamp will contain a nanosecond timestamp with full 32bit value range (external timestamper has free running 32bit timestamper sync'ed to seconds value of epoch)
0x0C01800B MODE 2: Offset of bits 47 to 32 of the T4 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x44 Bits [31:0] offset of the most significant 16 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0C01800A is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
0x0C01800C MODE 2: Offset of bits 31 to 0 of the T4 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x46 Bits [31:0] offset of the lease significant 32 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
0x0C01800D MODE 2: Offset of the T4 32-bit nanoseconds timestamp value from the start of the UDP or Ethernet payload RW 0x10 Bits [31:0] offset of the 32-bit nanosecond portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0C01800A is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0C000004). When the port is re-enabled the setting will take effect.
0x0C01800E Reserved - - Reserved

PTP Master Port 1 Configuration : Subsystem to allow user defined data to be sent between devices, eg GPS data

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C01C000 the length of time the data message is sent before it times out RW 10 The message is sent at a rate of 4Hz until this timeout or an acknowledge is received.
Default value is 2s, max value is 10s
Bits[31:8] = Reserved
Bits[7:0] = Number of repeats
0x0C01C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0C01C002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0C01C003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0C01C004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0C01C005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0C01C008 enable this system RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' will enable the system. This will start the timing of the system but no messages will be sent until the
data is ready to be sent
'0' disable the system.
0x0C01C009 send the data RW 0 Note that this will send the data to the first configured ptp port on the same domain at the receiver end.
Bits[31:1] = Reserved
Bits[0:0] = '1' - if there is data to send then this will start sending the data in a signalling message at a rate of 4Hz.
'0' - The system will automatically clear this bit when the data has been sent.
0x0C01C00A Reserved - - Reserved
0x0C01C010 length of data to send in words RW 0 Bits[31:16] = Reserved
Bits[15:0] = Length of data. Maximum size is 64 words
0x0C01C011 first 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the 64th word is contiguous.
0x0C01C050 last possible 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the 64th word is contiguous.

PTP Master Port 1 Configuration : Subsystem to allow user defined data to be received between devices, eg GPS data

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C020000 the length of time the acknowledge message is sent after which it times out RW 10 The acknowledge messages is sent at a rate of 4Hz until this timeout.
Default is 2, max value is 10s
Bits[31:8] = Reserved
Bits[7:0] = time in secs
0x0C020001 enable the receipt of user data RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' enable
'0' disable
0x0C020002 sender transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0C020003 sender transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0C020004 sender transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0C020005 sender transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0C020006 sender transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0C020008 data is ready to read RW 0 The users should clear this bit after reading the data
Bits[31:1] = Reserved
Bits[0:0] = '1' data has been received and can be read
'0' no data
0x0C020009 Reserved - - Reserved
0x0C020010 length of data received in words RO 0 Bits[31:16] = Reserved
Bits[15:0] = length of data
This value can be up to 64 words
0x0C020011 first 4 bytes of data received RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous
0x0C020050 last possible 4 bytes of data RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous

PTP Master Port 1 Configuration : Send smpte data between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0C024000 Default video frame rate of the slave system as a lowest term rational RW 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = numerator
0x0C024001 Default video frame rate of the slave system as a lowest term rational RW 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = denominator
0x0C024002 Complementary information to clockClass RW 0 This gives more information regarding the clock class.
Bits[31:8] = reserved
Bits[7:0] = 0: Not in use
1: Free Run
2: Cold Locking. In response to a disturbance, the grandmaster is re-locking quickly. In this situation, a rapid phase
adjustment with a time discontinuity can be expected.
3: Warm Locking. In response to a disturbance, the grandmaster is re-locking slowly by means of a frequency adjustment,
with no phase discontinuity. Time continuity is maintained.
4: Locked (i.e., in normal operation and stable)
0x0C024003 Indicates the intended SMPTE ST 12-1 flags RW 0 Bits[31:2] = reserved
Bits[1:0] = Bit 0: Drop frame
0: Non-drop-frame
1: Drop-frame
Bit 1: Color Frame Identification
0: Not in use
0x0C024004 Offset in seconds of Local Time from grandmaster PTP time RW 0 Bits[31:0] = offset in seconds
0x0C024005 The size of the next discontinuity in seconds of Local Time RW 0 Bits[31:0] = A value of zero indicates that no discontinuity is expected. A positive value indicates that the discontinuity will
cause the currentLocalOffset to increase.
0x0C024006 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RW 0 The discontinuity occurs at the start of the second indicated
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0C024007 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RW 0 The discontinuity occurs at the start of the second indicated
Bits[31:16] = reserved
Bits[15:0] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0C024008 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RW 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:16] = this is a 48 bit number where the top 32 bits are stored in this register
0x0C024009 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RW 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:16] = reserved
Bits[15:0] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0C02400A the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RW 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0C02400B the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RW 0 Bits[31:16] = reserved
Bits[15:0] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0C02400C The value of currentLocalOffset at the time of the previous Daily Jam event RW 0 Bits[31:0] = offset
If a discontinuity of Local Time occurs at the jam time, this parameter reflects the offset after the discontinuity
0x0C02400D indicates the daylight saving RW 0 Bits[31:3] = reserved
Bits[2:0] = Bit 0: Current Daylight Saving
0: Not in effect
1: In effect
Bit 1: Daylight Saving at next discontinuity
0: Not in effect
1: In effect
Bit 2: Daylight Saving at previous Daily Jam event
0: Not in effect
1: In effect
0x0C02400E The reason for the forthcoming discontinuity of currentLocalOffset indicated by timeOfNextJump RW 0 Bits[31:1] = reserved
Bits[0:0] = Bit 0:
0: Other than a change in the number of leap seconds (default)
1: A change in number of leap seconds
0x0C024010 enable the smpte sending RW 0 Bits[31:1] = reserved
Bits[0:0] = Bit 0:
0: disable
1: enable
0x0C024011 log period of the data sending rate RW 0 Bits[31:8] = reserved
Bits[7:0] = value from -2 (ie 4Hz) to 3 (1/8 Hz)
0x0C024012 send data now WO 0 Bits[31:1] = reserved
Bits[0:0] = if 1 is written then the data will be sent immediately

PTP Master Port 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x0D000000 General Parameters
0x0D004000 Generic Parameters
0x0D008000 Grant configuration details
0x0D00C000 Details of all the announce grants, up to 1024 of these
0x0D010000 Details of all the sync grants, up to 1024 of these
0x0D014000 Details of all the delay resp grants, up to 1024 of these
0x0D018000 Detailed setup of PTP mode
0x0D01C000 Subsystem to allow user defined data to be sent between devices, eg GPS data
0x0D020000 Subsystem to allow user defined data to be received between devices, eg GPS data
0x0D024000 Send smpte data between devices

PTP Master Port 2 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D000000 physical port connector RW 0 Bits[31:8] reserved
Bits[7:0] connector. The physical port that this ptp port is connected to, starting from 0.
Notes: It is recommended that the first five words, connector, protocol, version, domain and configure are set at the same time.
0x0D000001 ptp port protocol RW 0 Bits[31:2] reserved
Bits[1:0] protocol. The protocol used in the ptp port.
0 udp4,
1 ethernet,
2 udp6
0x0D000002 ptp port version RO 2 Bits[31:3] reserved
Bits[2:0] version
1 version1,
2 version2
0x0D000003 ptp port domain RW 0 Bits[31:8] reserved
Bits[7:0] domain (starting from 0)
Notes: Set the domain number of the ptp port. This can be set at the same time as configuring the ptp port.
It can also be set by itself when a ptp port has already been configured.
It will only be able to communicate with other ptp ports on the same domain.
0x0D000004 configure ptp port RW 0 Bits[31:1] reserved
Bits[0:0] configure
0 deconfigure,
1 configure
Notes: Configures the ptp port with the settings physical port connector, ptp port protocol, ptp port version and domain.
This will also bring the ptp port up to its initial values and start up the network interface
0x0D000005 enable ptp port RW 0 Bits[31:1] reserved
Bits[0:0] enable
0 disable,
1 enable
Notes: Enable the ptp port for use. If enabled it will allow the ptp port to begin moving through its states
0x0D000006 Timebase used for port master operations RW 4 Bits[31:3] = Reserved
Bits[2:0] = Source
Valid bit (decimal) values:
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
0x0D000007 virtual interface number RW 0 Bits[31:3] reserved
Bits[2:0] virtual interface number
0x0D000008 multi home index of address on interface RW 0 Bits[31:4] reserved
Bits[3:0] multi home index of address on interface
0x0D000010 The node id of the ptp port bytes 0 to 3 RW 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these two node id words in one go.
0x0D000011 The node id of the ptp port bytes 4 to 7 RW 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these two node id words in one go.
0x0D000012 The default node id of the ptp port RO 0x0 Bits[31:0] The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x0D000013 The default id of the ptp port RO 0x0 Bits[31:0] The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x0D000014 The state of the ptp port RO 0x0 Bits[31:4] reserved
Bits[3:0] state of the ptp port
0 = portFaulty,
1 = portDisabled,
2 = portListening,
3 = portPreMaster,
4 = portMaster,
5 = portPassive,
6 = portUncalibrated,
7 = portSlave
0x0D000015 best master clock algorithm mask RW 0xBE Bits[31:8] = reserved
Bits[7:0] = mask
0x01 GM Priority1
0x02 GM Identity
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values
Notes: Configures which steps in the best master clock algorithm are performed.
The default value is 0xBF, ie all steps enabled except for Steps Removed and Priority1
0x0D000016 better master available flag RO 0x0 Bits[31:1] = reserved
Bits[0:0] = flag
0 = true,
1 = false
Notes: This indicates if there is a better master available than the currently selected master.
0x0D000017 Reserved - - Reserved
0x0D000020 desired multicast announce log period RW 1 Bits[31:8] reserved
Bits[7:0] log period log base 2 as an sint8 (value can go from 6 to -4)
Notes: The desired multicast log period of the announce message.
The desired log period is the smallest (and hence fastest rate) that is desired.
The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0D000021 Reserved - - Reserved
0x0D000022 Reserved - - Reserved
0x0D000023 Reserved - - Reserved
0x0D000024 desired multicast sync log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired multicast log period of the sync message. The desired log period is the smallest (and hence fastest rate)
that is desired. The required log period is the largest (and hence slowest rate) that is satisfactory to the ptp port.
0x0D000025 Reserved - - Reserved
0x0D000026 Reserved - - Reserved
0x0D000027 Reserved - - Reserved
0x0D000028 desired multicast delay resp log period RW 1 Bits[31:8] reserved
Bits[7:0] log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Set desired multicast log period of the delay resp message. The desired log period is the smallest
(and hence fastest rate) that is desired. The required log period is the largest (and hence slowest rate) that is
satisfactory to the ptp port.
0x0D000029 Reserved - - Reserved
0x0D00002A Reserved - - Reserved
0x0D00002B Reserved - - Reserved
0x0D00002D Reserved - - Reserved
0x0D000050 enable/disable sending multicast announce messages RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable sending multicast announce messages
0 = disable sending multicast announce messages
Notes: ToPSync will not sent multicast announce messages when the PTP port address mode is unicastOnly.
0x0D000051 enable/disable sending multicast sync messages RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable sending multicast sync messages
0 = disable sending multicast sync messages
Notes: ToPSync will not send multicast sync messages when the PTP port addressing mode is unicastOnly.
0x0D000055 accept announce unicast grant requests RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = accept announce unicast grant requests
0 = drop announce unicast grant requests
Notes: ToPSync will drop unicast grant requests when the PTP port address mode is multicastOnly.
0x0D000056 accept sync unicast grant requests RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = accept sync unicast grant requests
0 = drop sync unicast grant requests
Notes: ToPSync will drop unicast grant requests when the PTP port address mode is multicastOnly.
0x0D000057 accept delay response unicast grant requests RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = accept delay response unicast grant requests
0 = drop delay response unicast grant requests
Notes: ToPSync will drop unicast grant requests when the PTP port address mode is multicastOnly.

PTP Master Port 2 Configuration : Generic Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D004000 addressing mode RW 0 Bits[31:2] = reserved
Bits[1:0] = addressing mode
asAppropriate = 0,
unicastOnly = 1,
multicastOnly = 2
Notes: Sets the addressing mode of the ptp port.
0x0D004001 enable path delay messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
This enables sending of path delay request messages.
0x0D004002 Reserved - - Reserved
0x0D004003 Reserved - - Reserved
0x0D004004 Reserved - - Reserved
0x0D004005 Reserved - - Reserved
0x0D004006 Reserved - - Reserved
0x0D00400A enable path delay response messages RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: This can only be enabled when path delay requests have been disabled.
0x0D00400B path delay value RW 0 Bits[31:0] = delay as a float value
0x0D004010 enable enhanced boundary clock RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the enhanced boundary clock.
0x0D004011 Reserved - - Reserved
0x0D004012 Reserved - - Reserved
0x0D004060 two step operation RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
0x0D004061 number of alternate masters RW 0 Sets the number of alternate masters. If greater than zero then the number of masters operational on this domain
will be this value + 1.
Bits[31:8] = reserved
Bits[7:0] = number (from 0)
0x0D004062 Reserved - - Reserved
0x0D004063 master renewal flag RW 1 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Sets the master renewal flag. If TRUE then this means the master is likely to renew new grant requests
0x0D004064 master refusal flag RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Sets the master refusal flag. If the master is unable to grant a requested rate then if this flag is set it will
refuse the grant request rather than offer a lower rate.
0x0D004065 not become master if tai unknown RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: If this is set then the ptp port will only become a master if TAI is known
0x0D004066 not become master if utc unknown RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: If this is set then the ptp port will only become a master if UTC is known
0x0D004067 not become master if not prs RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: If this is set then the ptp port will only become a master if the source is a primary reference source
0x0D004068 primary reference source clock stratum value RW 6 Bits[31:8] = reserved
Bits[7:0] = Clock stratum level
Notes: This value will be used when comparing the clock class on setting the Freq Traceable flag in ptp messages.
The default value is clock stratum level primaryReference (=6)
0x0D004069 override frequency traceable flag RW 0 Bits[31:2] = reserved
Bits[1:1] = if '1' then use the override the frequency traceable flag in ptp messages with the value in bit0.
Bits[0:0] = if '1' then frequency traceable flag is 1
if '0' then frequency traceable flag is 0
0x0D00406A always respond to unicast delay requests RW 0 Bits[31:1] = reserved
Bits[0:0] = if '1' then unicast delay requests are always responded to with unicast delay response
if '0' then the behaviour is as per the ptp port unicast/multicast/asAppropriate setting
Notes: Normally a unicast delay response is responded to only if the ptp port is unicast and the grant mechanism is used.
A unicast delay request would also be responded to if the Forced Grant Mechanism in the AMT and AST has been configured.
This 'always respond to unicast delay request' setting is used for the case where the ptp master is multicast and no grants
have been set up and no Forced Grant mechanism has been used.
In this mode no checks are made as to the ability of the port to be provide the responses at the rate coming in so this
is to be sparingly.
0x0D00406B Reserved - - Reserved
0x0D00406C override announce GM_ID high 32 bit RW 0 Bits[31:0] = grandmaster id
Notes: This value will be used to override the grandmaster id in announce messages.
0x0D00406D override announce GM_ID low 32 bit RW 0 Bits[31:0] = grandmaster id
Notes: This value will be used to override the grandmaster id in announce messages.
0x0D00406E override announce grandmaster id enable RW 0 Bits[31:1] = reserved
Bits[0:0] = if '0' then disable override GM_ID high and low to announce.
if '1' then enable override GM_ID high and low to announce.

PTP Master Port 2 Configuration : Grant configuration details

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D008000 max number of slaves RW 1024 Bits[31:16] reserved
Bits[15:0] max number.
Notes: This is the number of slaves to produce grants for, eg with the default values there can be
up to 10 1024 announce grants, 1024 sync grants and 1024 delay resp grants
0x0D008001 max total announce rate RW 512 Bits[31:0] max rate.
Notes: This is the maximum total announce rate. The summation of all the announce rates on this master cannot
exceed this value.
0x0D008002 max total sync rate RW 8192 Bits[31:0] max rate.
Notes: This is the maximum total sync rate . The summation of all the sync rates on this master cannot
exceed this value.
0x0D008003 max total delay resp rate RW 8192 Bits[31:0] max rate.
Notes: This is the maximum total delay response rate. The summation of all the delay resp rates on this master cannot
exceed this value.
0x0D008004 min announce log period RW -4 Bits[31:8] reserved
Bits[7:0] Min log period base 2 as sint8
Notes: This is the minimum announce log period for a grant.
0x0D008005 min sync log period RW -7 Bits[31:8] reserved
Bits[7:0] Min log period base 2 as sint8
Notes: This is the minimum sync log period for a grant.
0x0D008006 min delay response log period RW -7 Bits[31:8] reserved
Bits[7:0] Min log period base 2 as sint8
Notes: This is the minimum delay response log period for a grant.
0x0D008007 max announce duration RW 300 Bits[31:0] max duration.
Notes: This is the maximum duration of an announce grant.
0x0D008008 max sync duration RW 300 Bits[31:0] max duration.
Notes: This is the maximum duration of a sync grant.
0x0D008009 max delay response duration RW 300 Bits[31:0] max duration.
Notes: This is the maximum duration of a delay response grant.
0x0D00800A number of announce grants issued RO 0 Bits[31:0] number.
Notes: This is the number of announce grants that are currently issued
0x0D00800B number of sync grants issued RO 0 Bits[31:0] number.
Notes: This is the number of sync grants that are currently issued
0x0D00800C number of delay resp grants issued RO 0 Bits[31:0] number.
Notes: This is the number of delay response grants that are currently issued
0x0D00800D announce grant change counter RO 0 Bits[31:0] number.
Notes: This value increments every time an announce grant is renewed or created. This should be called
periodically and if it has changed then the user can obtain new information on the grants issued.
0x0D00800E sync grant change counter RO 0 Bits[31:0] number.
Notes: This value increments every time a sync grant is renewed or created. This should be called
periodically and if it has changed then the user can obtain new information on the grants issued.
0x0D00800F delay response grant change counter RO 0 Bits[31:0] number.
Notes: This value increments every time a delay response grant is renewed or created. This should be called
periodically and if it has changed then the user can obtain new information on the grants issued.
0x0D008010 Reserved - - Reserved
0x0D008011 Reserved - - Reserved
0x0D008012 Reserved - - Reserved
0x0D008013 Reserved - - Reserved
0x0D008014 Reserved - - Reserved
0x0D008015 Reserved - - Reserved
0x0D008016 Reserved - - Reserved
0x0D008017 Reserved - - Reserved

PTP Master Port 2 Configuration : Details of all the announce grants, up to 1024 of these

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D00C000 grant 1 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C001 grant 1 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C002 grant 1 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C003 grant 1 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C004 grant 1 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C005 grant 1 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C006 grant 1 announce log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C007 grant 1 announce duration RO 0 Bits[31:0] = announce grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C00A grant 2 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C00B grant 2 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C00C grant 2 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C00D grant 2 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C00E grant 2 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C00F grant 2 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C010 grant 2 announce log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00C011 grant 2 announce duration RO 0 Bits[31:0] = announce grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7F6 grant 1024 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7F7 grant 1024 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7F8 grant 1024 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7F9 grant 1024 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7FA grant 1024 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7FB grant 1024 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7FC grant 1024 announce log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7FD grant 1024 announce duration RO 0 Bits[31:0] = announce grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D00E7FE Reserved - - Reserved

PTP Master Port 2 Configuration : Details of all the sync grants, up to 1024 of these

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D010000 grant 1 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010001 grant 1 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010002 grant 1 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010003 grant 1 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010004 grant 1 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010005 grant 1 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010006 grant 1 sync log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010007 grant 1 sync duration RO 0 Bits[31:0] = sync grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01000A grant 2 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01000B grant 2 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01000C grant 2 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01000D grant 2 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01000E grant 2 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01000F grant 2 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010010 grant 2 sync log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D010011 grant 2 sync duration RO 0 Bits[31:0] = sync grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127F6 grant 1024 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127F7 grant 1024 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127F8 grant 1024 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127F9 grant 1024 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127FA grant 1024 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127FB grant 1024 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127FC grant 1024 sync log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127FD grant 1024 sync duration RO 0 Bits[31:0] = sync grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0127FE Reserved - - Reserved

PTP Master Port 2 Configuration : Details of all the delay resp grants, up to 1024 of these

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D014000 grant 1 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014001 grant 1 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014002 grant 1 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014003 grant 1 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014004 grant 1 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014005 grant 1 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014006 grant 1 delay response log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014007 grant 1 delay response duration RO 0 Bits[31:0] = delay response grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014008 Reserved - - Reserved
0x0D01400A grant 2 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01400B grant 2 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01400C grant 2 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01400D grant 2 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01400E grant 2 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D01400F grant 2 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014010 grant 2 delay response log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D014011 grant 2 delay response duration RO 0 Bits[31:0] = delay response grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167F6 grant 1024 transmission protocol RO 0 Bits[31:3] = reserved
Bits[2:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The grantee's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167F7 grant 1024 transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167F8 grant 1024 transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167F9 grant 1024 transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167FA grant 1024 transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167FB grant 1024 transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the slave's address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167FC grant 1024 delay response log period RO 0 Bits[31:8] = Reserved
Bits[7:0] = log period base 2 as a signed int
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D0167FD grant 1024 delay response duration RO 0 Bits[31:0] = delay response grant duration in secs
Notes: The sequence of parameter addresses is continued for grants 1 through to 1024
0x0D016800 Reserved - - Reserved
0x0D016801 Reserved - - Reserved
0x0D016802 Reserved - - Reserved

PTP Master Port 2 Configuration : Detailed setup of PTP mode

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D018000 Reserved - - Reserved
0x0D018001 Reserved - - Reserved
0x0D018002 Reserved - - Reserved
0x0D018003 Reserved - - Reserved
0x0D018004 Whether egress sync packets are timestamped RW 1 Bits[31:1] reserved
Bits[0:0] flag defining whether sync PTP packets are timestamped as they leave ToPSync or whether a user defined pattern is written into the origin timestamp field instead.
1 - the sync PTP packet's origin timestamp field is filled with the packet egress time (default)
0 - the sync PTP packet's origin timestamp field is filled with a user defined pattern (see registers 0x0D018005-0x0D018007) and is not timestamped.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
0x0D018005 Egress sync timestamp-pattern seconds bits 47 to 32 RW 0 Bits[31:16] = reserved
Bits[31:0] = pattern that will be written into seconds bits 47 to 32 of the egress sync origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
Notes: This pattern is only used when egress sync packets are NOT being timestamped.
See also: Register 0x0D018004.
0x0D018006 Egress sync timestamp-pattern seconds bits 31 to 0 RW 0 Bits[31:0] = pattern that will be written into seconds bits 31 to 0 of the egress sync origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
Notes: This pattern is only used when egress sync packets are NOT being timestamped.
See also: Register 0x0D018004.
0x0D018007 Egress sync timestamp-pattern nanoseconds RW 0 Bits[31:0] = pattern that will be written into nanoseconds bits 31 to 0 of the egress sync origin timestamp.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
Notes: This pattern is only used when egress sync packets are NOT being timestamped.
See also: register 0x0D018004.
0x0D018008 Major mode (general mode) of T4 delivery from remote PHY to ToPSync master RW 0 Bits[31:4] reserved
Bits[3:0] major timestamping mode defining how PTP packet T4 timestamp values are delivered to ToPSync.
0 - Normal - For sync packets this implies that the remote PHY is one step. Whether the egress sync is timestamped depends on the register 0x0D018004. For delay request packets this implies that the packet is timestamped locally on ingress to TopSync.
1 - Reserved
2 - TLV - Only applies to ingress delay request packets. The PHY has timestamped the ingress time and appended it to the delay request as a Semtech proprietary TLV.
3 - Embedded - Only applies to ingress delay request packets. The PHY has timestamped the ingress time and embedded the timestamp in the Ethernet packet.
4 - Reserved
5 - Correction field adjustment - For sync packets this may or may not mean that the packet is timestamped as it leaves TopSync. For delay request packets, it means that the ingress delay request packet is timestamped locally and the remote PHY has also adjusted the packet's CF as described in UG-TS2 01.
6-15 - Reserved

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
0x0D018009 Detailed description of the general mode of timestamp delivery RW 0 Bits[31:4] reserved
Bits[3:0] minor timestamping mode defining the format of the timestamp information delivered back to ToPSync. Register value meanings depend on register setting of 0x0D018008. If the major mode (register 0x0D018008) is "0 - normal" then this register is ignored.

If the major mode is "1 - DRM" then valid configuration is as follows.
1 - DRMs delivered via Ethernet only. SPI DRMs will be ignored.
2 - DRMs delivered via SPI. Ethernet DRMs will be ignored.
3 - DRMS delivered via Ethernet or SPI.

If the major mode is "2- TLV" then valid configuration is as follows.
1 - Short TLV format is expected.
2 - Long TLV format is expected.

Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
0x0D01800A Format of t4 timestamps RW 1 Bits[31:4] reserved
Bits[3:0] timestamp format. Defines whether timestamp will be nanoseconds only or full seconds and nanoseconds. If the major mode (register 0x0D018008) is "0 - normal" then this register is ignored.
0 - 32-bit nanosecond timestamps expected.
1 - full 48-bit seconds and 32-bit nanoseconds (IEEE1588) timestamps expected.
2 - timestamp will contain a nanosecond timestamp with full 32bit value range (external timestamper has free running 32bit timestamper sync'ed to seconds value of epoch)
0x0D01800B MODE 2: Offset of bits 47 to 32 of the T4 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x44 Bits [31:0] offset of the most significant 16 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0D01800A is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
0x0D01800C MODE 2: Offset of bits 31 to 0 of the T4 48-bit seconds timestamp value from the start of the UDP or Ethernet payload RW 0x46 Bits [31:0] offset of the lease significant 32 bits of the second portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
0x0D01800D MODE 2: Offset of the T4 32-bit nanoseconds timestamp value from the start of the UDP or Ethernet payload RW 0x10 Bits [31:0] offset of the 32-bit nanosecond portion of the unstructured in-band timestamp value from the start of the PTP payload. The offset may go past the end of the PTP packet payload as long as the encapsulating protocol payload is extended appropriately to contain the timestamp value.

Notes: Register is only relevant when unstructured in-band timstamp delivery is being used and 0x0D01800A is '1'.
Notes: This register must only be changed when the PTP port is deconfigured (see register 0x0D000004). When the port is re-enabled the setting will take effect.
0x0D01800E Reserved - - Reserved

PTP Master Port 2 Configuration : Subsystem to allow user defined data to be sent between devices, eg GPS data

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D01C000 the length of time the data message is sent before it times out RW 10 The message is sent at a rate of 4Hz until this timeout or an acknowledge is received.
Default value is 2s, max value is 10s
Bits[31:8] = Reserved
Bits[7:0] = Number of repeats
0x0D01C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0D01C002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0D01C003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0D01C004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0D01C005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0D01C008 enable this system RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' will enable the system. This will start the timing of the system but no messages will be sent until the
data is ready to be sent
'0' disable the system.
0x0D01C009 send the data RW 0 Note that this will send the data to the first configured ptp port on the same domain at the receiver end.
Bits[31:1] = Reserved
Bits[0:0] = '1' - if there is data to send then this will start sending the data in a signalling message at a rate of 4Hz.
'0' - The system will automatically clear this bit when the data has been sent.
0x0D01C00A Reserved - - Reserved
0x0D01C010 length of data to send in words RW 0 Bits[31:16] = Reserved
Bits[15:0] = Length of data. Maximum size is 64 words
0x0D01C011 first 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the 64th word is contiguous.
0x0D01C050 last possible 4 bytes of data to send RW 0 Bits[31:0] = data
The data words must all be set at the same time. Note that the data up to the 64th word is contiguous.

PTP Master Port 2 Configuration : Subsystem to allow user defined data to be received between devices, eg GPS data

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D020000 the length of time the acknowledge message is sent after which it times out RW 10 The acknowledge messages is sent at a rate of 4Hz until this timeout.
Default is 2, max value is 10s
Bits[31:8] = Reserved
Bits[7:0] = time in secs
0x0D020001 enable the receipt of user data RW 0 Bits[31:1] = Reserved
Bits[0:0] = '1' enable
'0' disable
0x0D020002 sender transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until the network interface on the physical port is configured
In these cases it will calculate the value depending on the ptp port configuration's protocol.
0x0D020003 sender transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these four transmission protocol words in one go.
0x0D020004 sender transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these four transmission protocol words in one go.
0x0D020005 sender transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these four transmission protocol words in one go.
0x0D020006 sender transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these four transmission protocol words in one go.
0x0D020008 data is ready to read RW 0 The users should clear this bit after reading the data
Bits[31:1] = Reserved
Bits[0:0] = '1' data has been received and can be read
'0' no data
0x0D020009 Reserved - - Reserved
0x0D020010 length of data received in words RO 0 Bits[31:16] = Reserved
Bits[15:0] = length of data
This value can be up to 64 words
0x0D020011 first 4 bytes of data received RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous
0x0D020050 last possible 4 bytes of data RO 0 Bits[31:0] = Four bytes of received data
These received data bytes up to the length must be read at the same time.
Note that the data up to the 64th word of data received is contiguous

PTP Master Port 2 Configuration : Send smpte data between devices

[Back to index | Back to parent block]
Address Name RW Default Description
0x0D024000 Default video frame rate of the slave system as a lowest term rational RW 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = numerator
0x0D024001 Default video frame rate of the slave system as a lowest term rational RW 0 The data type shall be composed of a pair of unsigned Int32 values coded in big-endian form where the first shall be the numerator
and the second shall be the denominator. The denominator shall be the smallest value that represents the frame rate denominator.
Bits[31:0] = denominator
0x0D024002 Complementary information to clockClass RW 0 This gives more information regarding the clock class.
Bits[31:8] = reserved
Bits[7:0] = 0: Not in use
1: Free Run
2: Cold Locking. In response to a disturbance, the grandmaster is re-locking quickly. In this situation, a rapid phase
adjustment with a time discontinuity can be expected.
3: Warm Locking. In response to a disturbance, the grandmaster is re-locking slowly by means of a frequency adjustment,
with no phase discontinuity. Time continuity is maintained.
4: Locked (i.e., in normal operation and stable)
0x0D024003 Indicates the intended SMPTE ST 12-1 flags RW 0 Bits[31:2] = reserved
Bits[1:0] = Bit 0: Drop frame
0: Non-drop-frame
1: Drop-frame
Bit 1: Color Frame Identification
0: Not in use
0x0D024004 Offset in seconds of Local Time from grandmaster PTP time RW 0 Bits[31:0] = offset in seconds
0x0D024005 The size of the next discontinuity in seconds of Local Time RW 0 Bits[31:0] = A value of zero indicates that no discontinuity is expected. A positive value indicates that the discontinuity will
cause the currentLocalOffset to increase.
0x0D024006 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RW 0 The discontinuity occurs at the start of the second indicated
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0D024007 the seconds portion of the grandmaster PTP time at the time that the next discontinuity of the currentLocalOffset RW 0 The discontinuity occurs at the start of the second indicated
Bits[31:16] = reserved
Bits[15:0] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0D024008 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RW 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:16] = this is a 48 bit number where the top 32 bits are stored in this register
0x0D024009 The value of the seconds portion of the PTP time corresponding to the next scheduled occurrence of the Daily Jam RW 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:16] = reserved
Bits[15:0] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0D02400A the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RW 0 If no Daily Jam is scheduled, the value of timeOfNextJam shall be zero
Bits[31:0] = this is a 48 bit number where the top 32 bits are stored in this register
0x0D02400B the seconds portion of the PTP time corresponding to the previous occurrence of the Daily Jam RW 0 Bits[31:16] = reserved
Bits[15:0] = this is a 48 bit number where the bottom 16 bits are stored in this register
0x0D02400C The value of currentLocalOffset at the time of the previous Daily Jam event RW 0 Bits[31:0] = offset
If a discontinuity of Local Time occurs at the jam time, this parameter reflects the offset after the discontinuity
0x0D02400D indicates the daylight saving RW 0 Bits[31:3] = reserved
Bits[2:0] = Bit 0: Current Daylight Saving
0: Not in effect
1: In effect
Bit 1: Daylight Saving at next discontinuity
0: Not in effect
1: In effect
Bit 2: Daylight Saving at previous Daily Jam event
0: Not in effect
1: In effect
0x0D02400E The reason for the forthcoming discontinuity of currentLocalOffset indicated by timeOfNextJump RW 0 Bits[31:1] = reserved
Bits[0:0] = Bit 0:
0: Other than a change in the number of leap seconds (default)
1: A change in number of leap seconds
0x0D024010 enable the smpte sending RW 0 Bits[31:1] = reserved
Bits[0:0] = Bit 0:
0: disable
1: enable
0x0D024011 log period of the data sending rate RW 0 Bits[31:8] = reserved
Bits[7:0] = value from -2 (ie 4Hz) to 3 (1/8 Hz)
0x0D024012 send data now WO 0 Bits[31:1] = reserved
Bits[0:0] = if 1 is written then the data will be sent immediately

Acceptable Master Table 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x12000000 AMT entry 1
0x12004000 AMT entry 2
0x12008000 AMT entry 3
0x1200C000 AMT entry 4
0x12010000 AMT entry 5
0x12014000 AMT entry 6
0x12018000 AMT entry 7
0x1201C000 AMT entry 8
0x12020000 AMT entry 9
0x12024000 AMT entry 10
0x12FFC000 General Parameters

Acceptable Master Table 1 Configuration : AMT entry 1

[Back to index | Back to parent block]
Address Name RW Default Description
0x12000000 Reserved - - Reserved
0x12000001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12000002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12000002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12000003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12000004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12000005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12000006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12000007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12000008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12000009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200000A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200000B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1200000C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1200000E.
0x1200000D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1200000E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1200000C mechanism.
0x1200000F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12000010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12000011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12000012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12000013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12000014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12000015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12000016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12000017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12000018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12000020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12000021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12000022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12000023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12000024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12000025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12000026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12000030 Reserved - - Reserved
0x12000080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 2

[Back to index | Back to parent block]
Address Name RW Default Description
0x12004000 Reserved - - Reserved
0x12004001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12004002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12004002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12004003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12004004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12004005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12004006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12004007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12004008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12004009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200400A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200400B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1200400C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1200400E.
0x1200400D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1200400E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1200400C mechanism.
0x1200400F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12004010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12004011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12004012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12004013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12004014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12004015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12004016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12004017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12004018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12004020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12004021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12004022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12004023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12004024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12004025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12004026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12004030 Reserved - - Reserved
0x12004080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 3

[Back to index | Back to parent block]
Address Name RW Default Description
0x12008000 Reserved - - Reserved
0x12008001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12008002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12008002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12008003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12008004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12008005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12008006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12008007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12008008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12008009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200800A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200800B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1200800C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1200800E.
0x1200800D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1200800E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1200800C mechanism.
0x1200800F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12008010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12008011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12008012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12008013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12008014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12008015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12008016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12008017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12008018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12008020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12008021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12008022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12008023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12008024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12008025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12008026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12008030 Reserved - - Reserved
0x12008080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 4

[Back to index | Back to parent block]
Address Name RW Default Description
0x1200C000 Reserved - - Reserved
0x1200C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x1200C002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1200C002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1200C003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1200C004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1200C005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1200C006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1200C007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1200C008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1200C009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200C00A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1200C00B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1200C00C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1200C00E.
0x1200C00D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1200C00E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1200C00C mechanism.
0x1200C00F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1200C010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1200C011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1200C012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x1200C013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1200C014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1200C015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x1200C016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x1200C017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x1200C018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x1200C020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x1200C021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1200C022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1200C023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1200C024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1200C025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1200C026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1200C030 Reserved - - Reserved
0x1200C080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 5

[Back to index | Back to parent block]
Address Name RW Default Description
0x12010000 Reserved - - Reserved
0x12010001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12010002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12010002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12010003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12010004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12010005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12010006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12010007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12010008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12010009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201000A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201000B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1201000C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1201000E.
0x1201000D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1201000E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1201000C mechanism.
0x1201000F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12010010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12010011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12010012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12010013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12010014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12010015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12010016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12010017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12010018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12010020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12010021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12010022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12010023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12010024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12010025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12010026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12010030 Reserved - - Reserved
0x12010080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 6

[Back to index | Back to parent block]
Address Name RW Default Description
0x12014000 Reserved - - Reserved
0x12014001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12014002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12014002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12014003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12014004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12014005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12014006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12014007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12014008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12014009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201400A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201400B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1201400C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1201400E.
0x1201400D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1201400E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1201400C mechanism.
0x1201400F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12014010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12014011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12014012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12014013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12014014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12014015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12014016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12014017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12014018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12014020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12014021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12014022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12014023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12014024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12014025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12014026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12014030 Reserved - - Reserved
0x12014080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 7

[Back to index | Back to parent block]
Address Name RW Default Description
0x12018000 Reserved - - Reserved
0x12018001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12018002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12018002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12018003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12018004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12018005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12018006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12018007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12018008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12018009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201800A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201800B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1201800C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1201800E.
0x1201800D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1201800E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1201800C mechanism.
0x1201800F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12018010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12018011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12018012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12018013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12018014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12018015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12018016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12018017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12018018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12018020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12018021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12018022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12018023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12018024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12018025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12018026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12018030 Reserved - - Reserved
0x12018080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 8

[Back to index | Back to parent block]
Address Name RW Default Description
0x1201C000 Reserved - - Reserved
0x1201C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x1201C002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1201C002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1201C003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1201C004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1201C005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1201C006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1201C007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1201C008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1201C009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201C00A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1201C00B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1201C00C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1201C00E.
0x1201C00D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1201C00E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1201C00C mechanism.
0x1201C00F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1201C010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1201C011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1201C012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x1201C013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1201C014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1201C015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x1201C016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x1201C017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x1201C018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x1201C020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x1201C021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1201C022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1201C023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1201C024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1201C025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1201C026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1201C030 Reserved - - Reserved
0x1201C080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 9

[Back to index | Back to parent block]
Address Name RW Default Description
0x12020000 Reserved - - Reserved
0x12020001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12020002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12020002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12020003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12020004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12020005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12020006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12020007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12020008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12020009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1202000A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1202000B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1202000C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1202000E.
0x1202000D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1202000E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1202000C mechanism.
0x1202000F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12020010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12020011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12020012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12020013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12020014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12020015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12020016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12020017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12020018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12020020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12020021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12020022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12020023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12020024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12020025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12020026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12020030 Reserved - - Reserved
0x12020080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : AMT entry 10

[Back to index | Back to parent block]
Address Name RW Default Description
0x12024000 Reserved - - Reserved
0x12024001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x12024002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x12024002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12024003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x12024004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x12024005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x12024006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12024007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x12024008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x12024009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1202400A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1202400B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1202400C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1202400E.
0x1202400D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1202400E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1202400C mechanism.
0x1202400F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12024010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12024011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12024012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x12024013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12024014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x12024015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x12024016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x12024017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x12024018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x12024020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x12024021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12024022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12024023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12024024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12024025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12024026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x12024030 Reserved - - Reserved
0x12024080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 1 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x12FFC000 Enable acceptable master table RW 0 This flag will enable or disable the acceptable master table.
Bits[31:0] = Enable (0= disable, 1 = enable)
0x12FFC001 validity of entries 1..10 RO 0 Bits[31:10] = reserved
Bits[9:0] = Bitfield
Notes: if entry 1 is valid then bit 0 in this field is 1, if entry 10 is valid then
bit 9 is 1 etc. Currently only 10 masters are supported

Visible Master Table 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x13000000 VMT entry 1
0x13004000 VMT entry 2
0x13008000 VMT entry 3
0x1300C000 VMT entry 4
0x13010000 VMT entry 5
0x13014000 VMT entry 6
0x13018000 VMT entry 7
0x1301C000 VMT entry 8
0x13020000 VMT entry 9
0x13024000 VMT entry 10
0x13FFC000 General Parameters

Visible Master Table 1 Configuration : VMT entry 1

[Back to index | Back to parent block]
Address Name RW Default Description
0x13000000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13000001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13000002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13000003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13000004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13000005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13000006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13000007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13000008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13000009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1300000A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300000B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13000014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13000015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13000016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13000017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13000018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13000019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1300001A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1300001B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1300001C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300001D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1300001E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13000028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13000029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300002A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300002B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300002C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300002D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300002E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300002F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13000030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13000031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300003C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13000046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13000047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13000048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13000049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300004A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300004B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300004C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300004D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300004E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13000064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13000065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13000066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13000067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13000068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13000069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1300006A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1300006E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1300006F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13000070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13000071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13000072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13000073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13000074 Reserved - - Reserved
0x13000075 Reserved - - Reserved
0x13000076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 2

[Back to index | Back to parent block]
Address Name RW Default Description
0x13004000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13004001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13004002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13004003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13004004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13004005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13004006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13004007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13004008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13004009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1300400A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300400B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13004014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13004015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13004016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13004017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13004018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13004019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1300401A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1300401B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1300401C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300401D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1300401E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13004028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13004029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300402A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300402B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300402C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300402D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300402E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300402F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13004030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13004031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300403C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13004046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13004047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13004048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13004049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300404A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300404B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300404C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300404D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300404E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13004064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13004065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13004066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13004067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13004068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13004069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1300406A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1300406E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1300406F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13004070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13004071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13004072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13004073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13004074 Reserved - - Reserved
0x13004075 Reserved - - Reserved
0x13004076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 3

[Back to index | Back to parent block]
Address Name RW Default Description
0x13008000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13008001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13008002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13008003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13008004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13008005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13008006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13008007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13008008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13008009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1300800A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300800B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13008014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13008015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13008016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13008017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13008018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13008019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1300801A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1300801B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1300801C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300801D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1300801E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13008028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13008029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300802A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300802B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300802C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300802D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300802E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300802F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13008030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13008031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300803C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13008046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13008047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13008048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13008049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300804A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300804B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300804C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300804D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300804E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13008064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13008065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13008066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13008067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13008068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13008069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1300806A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1300806E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1300806F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13008070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13008071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13008072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13008073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13008074 Reserved - - Reserved
0x13008075 Reserved - - Reserved
0x13008076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 4

[Back to index | Back to parent block]
Address Name RW Default Description
0x1300C000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x1300C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x1300C002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x1300C003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x1300C004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x1300C005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x1300C006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x1300C007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x1300C008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x1300C009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1300C00A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300C00B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1300C014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x1300C015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x1300C016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x1300C017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x1300C018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x1300C019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1300C01A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1300C01B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1300C01C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1300C01D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1300C01E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x1300C028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C02A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C02B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C02C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C02D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C02E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C02F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1300C03C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x1300C046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C04A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C04B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C04C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C04D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C04E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1300C064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x1300C065 the time lag RO 0 Bits[31:0] = time lag as a float
0x1300C066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x1300C067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x1300C068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x1300C069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1300C06A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1300C06E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1300C06F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x1300C070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x1300C071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1300C072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1300C073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1300C074 Reserved - - Reserved
0x1300C075 Reserved - - Reserved
0x1300C076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 5

[Back to index | Back to parent block]
Address Name RW Default Description
0x13010000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13010001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13010002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13010003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13010004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13010005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13010006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13010007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13010008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13010009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1301000A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301000B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13010014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13010015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13010016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13010017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13010018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13010019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1301001A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1301001B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1301001C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301001D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1301001E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13010028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13010029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301002A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301002B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301002C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301002D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301002E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301002F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13010030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13010031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301003C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13010046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13010047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13010048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13010049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301004A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301004B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301004C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301004D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301004E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13010064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13010065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13010066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13010067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13010068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13010069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1301006A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1301006E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1301006F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13010070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13010071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13010072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13010073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13010074 Reserved - - Reserved
0x13010075 Reserved - - Reserved
0x13010076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 6

[Back to index | Back to parent block]
Address Name RW Default Description
0x13014000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13014001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13014002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13014003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13014004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13014005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13014006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13014007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13014008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13014009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1301400A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301400B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13014014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13014015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13014016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13014017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13014018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13014019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1301401A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1301401B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1301401C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301401D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1301401E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13014028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13014029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301402A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301402B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301402C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301402D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301402E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301402F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13014030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13014031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301403C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13014046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13014047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13014048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13014049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301404A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301404B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301404C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301404D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301404E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13014064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13014065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13014066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13014067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13014068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13014069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1301406A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1301406E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1301406F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13014070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13014071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13014072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13014073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13014074 Reserved - - Reserved
0x13014075 Reserved - - Reserved
0x13014076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 7

[Back to index | Back to parent block]
Address Name RW Default Description
0x13018000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13018001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13018002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13018003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13018004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13018005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13018006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13018007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13018008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13018009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1301800A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301800B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13018014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13018015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13018016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13018017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13018018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13018019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1301801A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1301801B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1301801C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301801D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1301801E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13018028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13018029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301802A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301802B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301802C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301802D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301802E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301802F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13018030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13018031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301803C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13018046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13018047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13018048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13018049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301804A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301804B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301804C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301804D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301804E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13018064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13018065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13018066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13018067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13018068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13018069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1301806A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1301806E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1301806F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13018070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13018071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13018072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13018073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13018074 Reserved - - Reserved
0x13018075 Reserved - - Reserved
0x13018076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 8

[Back to index | Back to parent block]
Address Name RW Default Description
0x1301C000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x1301C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x1301C002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x1301C003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x1301C004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x1301C005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x1301C006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x1301C007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x1301C008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x1301C009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1301C00A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301C00B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1301C014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x1301C015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x1301C016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x1301C017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x1301C018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x1301C019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1301C01A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1301C01B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1301C01C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1301C01D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1301C01E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x1301C028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C02A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C02B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C02C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C02D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C02E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C02F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1301C03C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x1301C046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C04A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C04B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C04C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C04D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C04E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1301C064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x1301C065 the time lag RO 0 Bits[31:0] = time lag as a float
0x1301C066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x1301C067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x1301C068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x1301C069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1301C06A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1301C06E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1301C06F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x1301C070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x1301C071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1301C072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1301C073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1301C074 Reserved - - Reserved
0x1301C075 Reserved - - Reserved
0x1301C076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 9

[Back to index | Back to parent block]
Address Name RW Default Description
0x13020000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13020001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13020002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13020003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13020004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13020005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13020006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13020007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13020008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13020009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1302000A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1302000B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13020014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13020015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13020016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13020017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13020018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13020019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1302001A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1302001B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1302001C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1302001D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1302001E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13020028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13020029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302002A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302002B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302002C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302002D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302002E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302002F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13020030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13020031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302003C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13020046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13020047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13020048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13020049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302004A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302004B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302004C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302004D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302004E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13020064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13020065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13020066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13020067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13020068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13020069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1302006A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1302006E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1302006F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13020070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13020071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13020072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13020073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13020074 Reserved - - Reserved
0x13020075 Reserved - - Reserved
0x13020076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : VMT entry 10

[Back to index | Back to parent block]
Address Name RW Default Description
0x13024000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x13024001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x13024002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x13024003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x13024004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x13024005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x13024006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x13024007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x13024008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x13024009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1302400A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1302400B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x13024014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x13024015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x13024016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x13024017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x13024018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x13024019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1302401A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1302401B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1302401C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1302401D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1302401E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x13024028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13024029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302402A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302402B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302402C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302402D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302402E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302402F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13024030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x13024031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1302403C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x13024046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13024047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13024048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13024049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302404A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302404B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302404C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302404D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1302404E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x13024064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x13024065 the time lag RO 0 Bits[31:0] = time lag as a float
0x13024066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x13024067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x13024068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x13024069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1302406A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1302406E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1302406F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x13024070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x13024071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13024072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13024073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x13024074 Reserved - - Reserved
0x13024075 Reserved - - Reserved
0x13024076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 1 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x13FFC000 Visible masters' mask RO 0 Bits[31:0] = bit mask
Notes: Retrieves the bit mask of the visible masters, where each bit represents which visible master is there.
Eg if the mask = 0x3 this means the first two bits are set and so there are visible masters in the first two
locations.
0x13FFC001 grants issued change counter RO 0 Bits[31:0] = integer
Notes: This should be periodically called to keep a track of whether new grants have been issued.
eg if the value is different than the last time then this difference is the number of grants issued

PTP PLL 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x14000000 Source status
0x14004000 Source configuration
0x14008000 Source reference clock
0x1400C000 UTC Offset
0x14020000 Source Input
0x14028000 Holdover Controller
0x1402C000 Binary Lock Monitor
0x14030000 Frequency offset

PTP PLL 1 Configuration : Source status

[Back to index | Back to parent block]
Address Name RW Default Description
0x14000000 Source state RO 0 Bits[31:3] reserved
Bits[2:0] Source state. Valid values:
0 void. Empty
1 invalid. No time is available.
2 valid. Time is available but the source has not been selected.
3 measuring. The source has been selected and is measuring freq or phase offset.
4 holdover. The source has lost lock and is currently in holdover.
5 running. The source is providing time information.
0x14000001 Source phase lag error RO - Bits[31:0] Phase lag error expressed as a single precision floating point number
0x14000002 Source measured noise RO - Bits[31:0] Measured noise expressed as a single precision floating point number
This is the mean of noise in both directions
0x14000003 Source holdover validity RO - Bits[31:0] Holdover validity expressed as a single precision floating point number
0x14000004 Source lock value RO - Bits[31:0] Lock value expressed as a single precision floating point number
Range 0.0 to 1.0
0x14000005 Source locked state RO 0 Bits[31:1] Reserved
Bits[0] 0 - not locked, 1 - locked
0x14000006 Phase error gradient RO - Bits[31:0] Phase error gradient expressed as a single precision floating point number
This equals the frequency error of the PTP PLL with respect to its time source.
0x14000007 Source type RO - Bits[31:2] Reserved
Bits[1:0] 0 = Clock, 1 = Normal PTP, 2 = Hybrid PTP.
0x14000008 Phase output's accuracy (error range) RO 0 Bits[31:0] Phase output's accuracy is expressed as a single precision floating point number. Valid for Ptp source only.
Notes: This gives an estimate of the possible accuracy range of the phase output. Accuracy should always be a positive value. Value "0" means the accuracy estimate is not valid.
0x14000010 PTP PLL time secs bits 47 to 32 RO - Bits[31:16] = reserved
Bits[15:0] = PTP PLL time seconds bits 47 to 32 of 48 bit seconds field
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x14000011 PTP PLL time seconds bits 31 to 0 RO - Bits[31:0] = PTP PLL time seconds bits 31 to 0 of 48 bit seconds field
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x14000012 PTP PLL time nanoseconds RO - Bits[31:0] = PTP PLL time nanoseconds
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x14000013 PTP PLL time TAI flag RO - Bits[31:1] = reserved
Bits[0] = 1 is TAI flag is TRUE, 0 if FALSE
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x14000014 Reserved - - Reserved
0x14000020 Current value of input source Clock Class RO - Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
Note that this may not be the same as 0x14008002 if the source is in holdover.

PTP PLL 1 Configuration : Source configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x14004000 PTP PLL Unlocked Bandwidth RW 10.0e-3 Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x14004001 PTP PLL Locked Bandwidth RW 1.0e-3 Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x14004002 Frequency Measurement Duration RW 30 Bits[31:16] Reserved
Bits[15:0] Duration of the initial frequency measurement period in seconds
0x14004003 Frequency Measurement Minimum Packets RW 50 Bits[31:16] Reserved
Bits[15:0] The minimum number of packets to be used in the initial frequency measurement period.
0x14004004 Configured phase lag RW 0.0 Bits[31:0] Configured phase lag in seconds expressed as a single precision floating point number
0x14004005 Configured maximum phase error for phase jump RW 15e-6 Bits[31:0] Configured maximum phase error in seconds expressed as a single precision floating point number.
Notes: This parameter specifies the maximum phase error before the PTP slave does a phase jump to align with the master.
0x14004009 Minimum lock value to be master RW 0.1 Bits[31:0] Lock value expressed as a single precision floating point number
The minimum lock value for an input source used as a time reference on a PTP port for the port to enter master state
0x1400400A Enable fast calibration RW 0 Bits[31:1] Reserved
Bits[0] 1 = Enable, 0 = Disable
Notes: When enabled, TopSync will do fast calibration to align with the master in a very short period. This parameter should only be enabled when the network load is low and PTP packet rate is normal or high (32 pps or higher).
0x1400400B Reserved - - Reserved
0x1400400C Reserved - - Reserved
0x1400400D Reserved - - Reserved
0x1400400E Reserved - - Reserved
0x14004011 Reserved - - Reserved
0x1400400F Reserved - - Reserved
0x14004010 Reserved - - Reserved
0x14004014 Reserved - - Reserved
0x14004015 Reserved - - Reserved
0x14004016 Reserved - - Reserved
0x14004019 Reserved - - Reserved
0x1400401A Reserved - - Reserved
0x1400401B Reserved - - Reserved
0x1400401C PTP can be backup source to clock input such as GPS RW 0 Bits[31:1] Reserved
Bits[0] 1 = Can be, 0 = Can not be.
0x1400401E Reserved - - Reserved
0x1400401F Reserved - - Reserved
0x14004020 Time since last jump to align with the master RW - Bits[31:0] Unsigned integer in unit of second
Notes: Write to reset this register to indicate there is master jump. This register will increase one per second to record the time since last alignment with the master.
0x14004023 Phase buildout property for node time 1 RW 2 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Notes: The default value is different for PTP source and Clock source.
0x14004024 Phase buildout property for node time 2 RW 2 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Notes: The default value is different for PTP source and Clock source.
0x14004028 Lock detector's sensitivity multiple factor RW 1 Bits[31:0] Positive float value

PTP PLL 1 Configuration : Source reference clock

[Back to index | Back to parent block]
Address Name RW Default Description
0x14008000 Node ID bytes 0-3 RO 0 Bits[31:24] Node ID byte 0
Bits[23:16] Node ID byte 1
Bits[15:8] Node ID byte 2
Bits[7:0] Node ID byte 3
0x14008001 Node ID bytes 4-7 RO 0 Bits[31:24] Node ID byte 4
Bits[23:16] Node ID byte 5
Bits[15:8] Node ID byte 6
Bits[7:0] Node ID byte 7
0x14008002 Clock Class RO 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
0x14008003 Time Source RO 0 Bits[31:4] Reserved
Bits[3:0] Time source. Allowed values
000 Atomic clock
001 GPS
010 Terrestrial (radio)
011 PTP
100 NTP
101 Hand set
110 Other source
111 internalOscillator. No time reference at all
1000 smpte time source F0 (arb)
1001 smpte time source F1
0x14008004 Clock Accuracy RO 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock Accuracy. Allowed values:
0x20 NS25 The time is accurate to within 25 ns
0x21 NS100 The time is accurate to within 100 ns
0x22 NS250 The time is accurate to within 250 ns
0x23 US1 The time is accurate to within 1 us
0x24 US2_5 The time is accurate to within 2.5 us
0x25 US10 The time is accurate to within 10 us
0x26 US25 The time is accurate to within 25 us
0x27 US100 The time is accurate to within 100 us
0x28 US250 The time is accurate to within 250 us
0x29 MS1 The time is accurate to within 1 ms
0x2A MS2_5 The time is accurate to within 2.5 ms
0x2B MS10 The time is accurate to within 10 ms
0x2C MS25 The time is accurate to within 25 ms
0x2D MS100 The time is accurate to within 100 ms
0x2E MS250 The time is accurate to within 250 ms
0x2F S1 The time is accurate to within 1 s
0x30 S10 The time is accurate to within 10 s
0x31 GT10S The time is accurate to >10 s
0xFE ACC_UNKNOWN The time accuracy is unknown
0x14008005 Offset scaled log variance RO 0 Bits[31:16] Reserved
Bits[15:0] IEEE1588 Offset scaled log variance defined in 1588 v2 7.6.3.3
0x14008006 Time valid RO 0 Bits[31:1] Reserved
Bits[0] 1 - The time is a valid TAI time, 0 otherwise
0x14008007 Priority 1 value RO 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x14008008 Priority 2 value RO 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x14008009 Steps removed value RO 0 Bits[31:16] Reserved
Bits[15:0] Steps removed value
0x1400800A Local Priority value RO 0 Bits[31:8] Reserved
Bits[7:0] Local Priority value

PTP PLL 1 Configuration : UTC Offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x1400C000 UTC Offset Value RO 0 Bits[31:0] UTC Offset value as a signed integer. Valid range covers bits 15:0 only
Notes: if the PTP port does not have a source selected this value is invalid
0x1400C001 UTC Offset Value RO 0 Bits[31:1] Reserved
Bits[0] 1 UTC Offset value is valid, 0 UTC Offset value is invalid
Notes: if the PTP port does not have a source selected this value is invalid
0x1400C004 Days to leap second RO 0 Bits[31:0] Number of days as a signed integer. Valid range covers bits 15:0 only
If leap second will happen at the next midnight (UTC time) number of days = 0.
If leap second will happen at tomorrow's midnight (UTC time) number of days = 1.
Number of days must not be greater than MAX_WARNING_DAYS.
Setting this value to <0 will clear any pending leap second
It is advised to set this and the following register in one write operation.
Notes: if the PTP port does not have a source selected this value is invalid
0x1400C005 Leap second is positive RO 0 Bits[31:1] Reserved
Bits[0] 1 leap second jump is positive, 0 leap second jump is negative
It is advised to set this and the previous register in one write operation.
Notes: if the PTP port does not have a source selected this value is invalid

PTP PLL 1 Configuration : Source Input

[Back to index | Back to parent block]
Address Name RW Default Description
0x14020000 Input Source Exists RO 0 Bits[31:1] reserved
Bits[0] Input source exists:
1 - PTP PLL has input from an external source.
0 - PTP PLL has no current input
0x14020001 Visible Master Index RO 0xffffffff Bits[31:0] Index of current input source in visible master table
If PTP PLL has no current input the value is 0xffffffff
0x14020002 Input State RO - Bits[31:2] reserved
Bits[1:0] Input state of PTP PLL. Valid values:
00 Estimating frequency offset
01 Estimating phase offset.
10 Running.
0x14020003 Clock input mux to select LO or clock PLL for freq input RW 0 Bits[31:3] Reserved
Bits[2:0] Valid values (Other values are reserved):
0 - Local oscillator for frequency
1 - Clock PLL1 used as frequency input
2 - Clock PLL2 used as frequency input
0x14020004 Clock input is coherent RW 1 Bits[31:1] Reserved
Bits[0] 1 = Is coherent, 0 = Not coherent, or congruent
0x14020005 Reserved - - Reserved
0x14020006 Use configured PLL bandwdith RW 0 Bits[31:1] Reserved
Bits[0] 1 = Use Configured bandwdith, 0 = Use internal default bandwidth
Notes: this parameter may be set to TRUE for operation of Hybrid in Boundary Clock case.
0x1402000A Reserved - - Reserved
0x1402000B Reserved - - Reserved

PTP PLL 1 Configuration : Holdover Controller

[Back to index | Back to parent block]
Address Name RW Default Description
0x14028000 Holdover Duration RW 3600 Bits[31:0] Duration value as a unsigned integer.
0x14028001 Reset WO 0 Bits[31:1] = reserved
Bits[0] = any value.
Notes: This resets the holdover data used to maintain effective holdover in the absence
of an input source. It does not force the PLL to exit the holdover state and should not
be used when the PLL is in holdover
0x14028002 Disable/enable forceHoldover RW 0 Bits[31:1] = reserved
Bits[0] = 1 - ForceHoldover enabled, 0 - disabled
0x14028003 clock class on entering holdover RW 14 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value on entering holdover
0x14028004 clock class after holdover duration RW 193 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value after the holdover duration has expired
0x14028005 packet noise level triggering holdover state RW 10.0e-6 Bits[31:0] = positive float value
Notes: The valid minimum value for this parameter is 1.0e-6
0x14028006 Use local node ID for GM ID in holdover RW 0 Bits[31:1] = reserved
Bits[0] = 0 Keep previous GM (external) ID in holdover (default)
= 1 Change transmitted GM ID in PTP messages to local node ID in holdover

PTP PLL 1 Configuration : Binary Lock Monitor

[Back to index | Back to parent block]
Address Name RW Default Description
0x1402C000 Binary error acceptable RW 1.0e-6 Bits[31:0] value as a float value.
0x1402C001 Binary error unacceptable RW 5.0e-6 Bits[31:0] value as a float value.
0x1402C002 Binary error gradient acceptable RW 1.0e-9 Bits[31:0] value as a float value.
0x1402C003 Binary error gradient unaccpetable RW 2.5e-9 Bits[31:0] value as a float value.
0x1402C004 Binary fuzzy lock acceptable RW 0.5 Bits[31:0] value as a float value.
0x1402C005 Binary fuzzy lock unacceptable RW 0.25 Bits[31:0] value as a float value.
0x1402C006 Binary force lock RW 0 Bits[31:2] reserved.
Bits[1:0] 2 = Forced to UnLocked State, 1 = Forced to Locked State, 0 = Not Forced
0x1402C007 Binary maintain lock during source switch RW 0 Bits[31:1] reserved.
Bits[0] 1 = Maintain Lock, 0 = Not Maintain Lock
0x1402C008 Reserved - - Reserved
0x1402C009 Reserved - - Reserved

PTP PLL 1 Configuration : Frequency offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x14030000 Clock PLL max frequency offset RW 0 Bits[31:0] Max frequency offset in Hz expressed as a single precision floating point number
Value in Hz
0x14030001 Clock PLL CURRENT frequency offset RO 0 Bits[31:0] frequency offset in Hz expressed as a single precision floating point number
Value in Hz

Acceptable Master Table 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x15000000 AMT entry 1
0x15004000 AMT entry 2
0x15008000 AMT entry 3
0x1500C000 AMT entry 4
0x15010000 AMT entry 5
0x15014000 AMT entry 6
0x15018000 AMT entry 7
0x1501C000 AMT entry 8
0x15020000 AMT entry 9
0x15024000 AMT entry 10
0x15FFC000 General Parameters

Acceptable Master Table 2 Configuration : AMT entry 1

[Back to index | Back to parent block]
Address Name RW Default Description
0x15000000 Reserved - - Reserved
0x15000001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15000002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15000002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15000003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15000004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15000005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15000006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15000007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15000008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15000009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500000A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500000B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1500000C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1500000E.
0x1500000D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1500000E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1500000C mechanism.
0x1500000F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15000010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15000011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15000012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15000013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15000014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15000015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15000016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15000017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15000018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15000020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15000021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15000022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15000023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15000024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15000025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15000026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15000030 Reserved - - Reserved
0x15000080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 2

[Back to index | Back to parent block]
Address Name RW Default Description
0x15004000 Reserved - - Reserved
0x15004001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15004002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15004002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15004003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15004004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15004005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15004006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15004007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15004008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15004009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500400A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500400B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1500400C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1500400E.
0x1500400D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1500400E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1500400C mechanism.
0x1500400F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15004010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15004011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15004012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15004013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15004014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15004015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15004016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15004017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15004018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15004020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15004021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15004022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15004023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15004024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15004025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15004026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15004030 Reserved - - Reserved
0x15004080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 3

[Back to index | Back to parent block]
Address Name RW Default Description
0x15008000 Reserved - - Reserved
0x15008001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15008002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15008002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15008003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15008004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15008005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15008006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15008007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15008008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15008009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500800A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500800B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1500800C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1500800E.
0x1500800D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1500800E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1500800C mechanism.
0x1500800F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15008010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15008011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15008012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15008013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15008014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15008015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15008016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15008017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15008018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15008020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15008021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15008022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15008023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15008024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15008025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15008026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15008030 Reserved - - Reserved
0x15008080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 4

[Back to index | Back to parent block]
Address Name RW Default Description
0x1500C000 Reserved - - Reserved
0x1500C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x1500C002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1500C002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1500C003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1500C004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1500C005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1500C006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1500C007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1500C008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1500C009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500C00A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1500C00B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1500C00C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1500C00E.
0x1500C00D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1500C00E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1500C00C mechanism.
0x1500C00F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1500C010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1500C011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1500C012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x1500C013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1500C014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1500C015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x1500C016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x1500C017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x1500C018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x1500C020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x1500C021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1500C022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1500C023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1500C024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1500C025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1500C026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1500C030 Reserved - - Reserved
0x1500C080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 5

[Back to index | Back to parent block]
Address Name RW Default Description
0x15010000 Reserved - - Reserved
0x15010001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15010002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15010002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15010003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15010004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15010005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15010006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15010007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15010008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15010009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501000A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501000B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1501000C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1501000E.
0x1501000D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1501000E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1501000C mechanism.
0x1501000F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15010010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15010011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15010012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15010013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15010014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15010015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15010016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15010017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15010018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15010020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15010021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15010022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15010023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15010024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15010025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15010026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15010030 Reserved - - Reserved
0x15010080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 6

[Back to index | Back to parent block]
Address Name RW Default Description
0x15014000 Reserved - - Reserved
0x15014001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15014002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15014002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15014003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15014004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15014005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15014006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15014007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15014008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15014009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501400A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501400B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1501400C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1501400E.
0x1501400D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1501400E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1501400C mechanism.
0x1501400F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15014010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15014011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15014012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15014013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15014014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15014015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15014016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15014017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15014018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15014020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15014021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15014022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15014023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15014024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15014025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15014026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15014030 Reserved - - Reserved
0x15014080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 7

[Back to index | Back to parent block]
Address Name RW Default Description
0x15018000 Reserved - - Reserved
0x15018001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15018002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15018002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15018003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15018004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15018005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15018006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15018007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15018008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15018009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501800A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501800B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1501800C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1501800E.
0x1501800D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1501800E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1501800C mechanism.
0x1501800F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15018010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15018011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15018012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15018013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15018014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15018015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15018016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15018017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15018018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15018020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15018021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15018022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15018023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15018024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15018025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15018026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15018030 Reserved - - Reserved
0x15018080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 8

[Back to index | Back to parent block]
Address Name RW Default Description
0x1501C000 Reserved - - Reserved
0x1501C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x1501C002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1501C002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1501C003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1501C004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1501C005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1501C006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1501C007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x1501C008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1501C009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501C00A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1501C00B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1501C00C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1501C00E.
0x1501C00D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1501C00E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1501C00C mechanism.
0x1501C00F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1501C010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1501C011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1501C012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x1501C013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1501C014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x1501C015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x1501C016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x1501C017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x1501C018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x1501C020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x1501C021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1501C022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1501C023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1501C024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1501C025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1501C026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x1501C030 Reserved - - Reserved
0x1501C080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 9

[Back to index | Back to parent block]
Address Name RW Default Description
0x15020000 Reserved - - Reserved
0x15020001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15020002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15020002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15020003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15020004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15020005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15020006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15020007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15020008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15020009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1502000A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1502000B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1502000C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1502000E.
0x1502000D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1502000E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1502000C mechanism.
0x1502000F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15020010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15020011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15020012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15020013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15020014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15020015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15020016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15020017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15020018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15020020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15020021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15020022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15020023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15020024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15020025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15020026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15020030 Reserved - - Reserved
0x15020080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : AMT entry 10

[Back to index | Back to parent block]
Address Name RW Default Description
0x15024000 Reserved - - Reserved
0x15024001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either 0x15024002 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x15024002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15024003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x15024004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x15024005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x15024006 The acceptable master's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id

Notes: The first set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15024007 The acceptable master's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id

Notes: The second set of 4 bytes in the acceptable master's node id. Each byte in this uint32 will be a value in the address. eg In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.

It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
If the address words are non-zero but the nodeid words are set to 0xFFFFFFFF then the address will be used but the nodeid will be ignored.
0x15024008 The acceptable master's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable master.
If the PPTNUM has a value of 0xFFFF then it will act as a wild card.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x15024009 Priority 1 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1502400A Priority 2 of the acceptable master RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable master. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
This is now deprecated although will still work. Users should use the override facility later on in this
entry.
0x1502400B Unicast master flag RW 0 Bits[31:1] = reserved
Bits[0:0] = unicast
0 = multicast,
1 = unicast
Notes: Sets the acceptable master to be multicast or unicast
If unicast then the node will make unicast grant requests to this current master when this AMT entry is enabled, otherwise it will default to multicast.
0x1502400C forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable

Notes: Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without
requiring the usual process of establishing a contract through the exchange of signalling messages.
Setting this bit prevents the slave from requesting unicast announce, sync and delay response messages,
instead assuming that these will be provided without any negotiation, and enables the generation of delay request messages at the rate
programmed in this acceptable master table entry once the master starts sending announce messages
This mechanism should be enabled when the acceptable master entry field 'enabled' is FALSE. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started. Note that this mechanism cannot
be used at the same time as the mechanism used for register 0x1502400E.
0x1502400D forced grant delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay request log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Sets the forced grant delay request log period. This is the log period of the delay request message to be sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the forced grant flag is checked and if it is TRUE then the delay request messages are sent at this log period value.
0x1502400E use message rates flag RW 0 Bits[31:1] = reserved
Bits[0:0] = use message rates
0 = disable,
1 = enable

Notes: Enables the configuration of the various message rates to be used on a per master basis.
Usually the rates are defined on a per ptp port basis - this mechanism allows the rates to be set on a per master basis.
This mechanism should be enabled while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined after this should be used.
Note that this mechanism cannot be used at the same time as the register 0x1502400C mechanism.
0x1502400F desired announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired announce log period - log base 2 as an sint8 (value can go from 6 to -4)

Notes: Configures the desired announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15024010 desired sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15024011 desired delay request log period RW 0 Bits[31:8] = reserved
Bits[7:0] = desired delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the desired delay request message log period in use with the 'use message rates' mechanism.
The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15024012 required announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Configures the required announce message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used. /
0x15024013 required sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = required sync log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required sync message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15024014 required delay request log period RW 0 Bits[8:1] = reserved
Bits[7:0] = required delay req log period - log base 2 as an sint8 (value can go from 4 to -7)

Notes: Configures the required delay request message log period in use with the 'use message rates' mechanism. The desired rate is the best smallest possible log period (hence fastest rate) that is wanted, whereas the required rate is the highest log period (hence lowest rate) that can satisfactory to this slave.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the rates defined here should be used.
0x15024015 grant duration RW 0 Bits[31:0] = grant duration in seconds.

Notes: Configures the grant duration in use with the 'use message rates' mechanism.
Usually this rate is configured on a per ptp port basis,this setting allows it to be set on a per master basis.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then the use message rates flag is checked and if it is TRUE then the value defined here should be used.
0x15024016 master must have a primary reference source RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a primary reference source
0x15024017 master must have a TAI time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then it must have a TAI time
0x15024018 master must have a UTC time RW 0 Bits[31:1] = reserved
Bits[0:0] = 0 - ignore this field
1 - if a master is to be used as a source then its utc time must be valid
0x15024020 bit mask for what fields to override in BMCA RW 0 Bits[31:8] = reserved
Bits[7:0] = bitmask
Each bit represent a data item to override from the incoming Announce messages.
These items are taken from the Best Master Clock Algorithm and are in the same order
that they are used in the BMCA. If a bit is a '1' then the corresponding value is take from
the next 6 fields and will be stored in the Visible Master instead of the values from the Announce
message. Each bit represents an item in the BMCA and can have one of the following values:
0x01 GM Priority1
0x02 GM Identity (not used in this override facility)
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values (not used in this override facility)
0x15024021 Priority1 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 1 in the bit mask is a '1' then this Priority1 value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15024022 Clock class override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 3 in the bit mask is a '1' then this Clock class value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15024023 Accuracy override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 4 in the bit mask is a '1' then this Accuracy value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15024024 Offset scaled log variance override value RW 0 Bits[31:16] = reserved
Bits[15:0] = value from 0 to 0xFFFF. If bit 5 in the bit mask is a '1' then this log variance value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15024025 Priority2 override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 6 in the bit mask is a '1' then this Priority value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15024026 Steps removed override value RW 0 Bits[31:8] = reserved
Bits[7:0] = value from 0 to 255. If bit 7 in the bit mask is a '1' then this steps removed value will be
stored in the Visible Master and used in the BMCA instead of the one from the Announce message.
0x15024030 Reserved - - Reserved
0x15024080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable

Notes: Enables this acceptable master entry to be used.
When this is enabled the master can now be used as an acceptable master. If disabled then this means that master cannot be considered as an acceptable master. To configure any of the values described in this master entry then it is strongly recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in unexpected behaviour. If this entry is set up to be unicast then enabling this will start making unicast grant requests to the master. The forced grant and msg rates features will not start activating until both this entry and the acceptable master table are enabled.

Acceptable Master Table 2 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x15FFC000 Enable acceptable master table RW 0 This flag will enable or disable the acceptable master table.
Bits[31:0] = Enable (0= disable, 1 = enable)
0x15FFC001 validity of entries 1..10 RO 0 Bits[31:10] = reserved
Bits[9:0] = Bitfield
Notes: if entry 1 is valid then bit 0 in this field is 1, if entry 10 is valid then
bit 9 is 1 etc. Currently only 10 masters are supported

Visible Master Table 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x16000000 VMT entry 1
0x16004000 VMT entry 2
0x16008000 VMT entry 3
0x1600C000 VMT entry 4
0x16010000 VMT entry 5
0x16014000 VMT entry 6
0x16018000 VMT entry 7
0x1601C000 VMT entry 8
0x16020000 VMT entry 9
0x16024000 VMT entry 10
0x16FFC000 General Parameters

Visible Master Table 2 Configuration : VMT entry 1

[Back to index | Back to parent block]
Address Name RW Default Description
0x16000000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16000001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16000002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16000003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16000004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16000005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16000006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16000007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16000008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16000009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1600000A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600000B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16000014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16000015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16000016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16000017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16000018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16000019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1600001A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1600001B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1600001C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600001D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1600001E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16000028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16000029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600002A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600002B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600002C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600002D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600002E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600002F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16000030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16000031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600003C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16000046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16000047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16000048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16000049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600004A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600004B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600004C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600004D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600004E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16000064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16000065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16000066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16000067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16000068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16000069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1600006A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1600006E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1600006F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16000070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16000071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16000072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16000073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16000074 Reserved - - Reserved
0x16000075 Reserved - - Reserved
0x16000076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 2

[Back to index | Back to parent block]
Address Name RW Default Description
0x16004000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16004001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16004002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16004003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16004004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16004005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16004006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16004007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16004008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16004009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1600400A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600400B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16004014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16004015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16004016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16004017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16004018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16004019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1600401A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1600401B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1600401C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600401D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1600401E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16004028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16004029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600402A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600402B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600402C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600402D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600402E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600402F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16004030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16004031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600403C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16004046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16004047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16004048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16004049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600404A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600404B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600404C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600404D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600404E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16004064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16004065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16004066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16004067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16004068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16004069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1600406A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1600406E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1600406F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16004070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16004071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16004072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16004073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16004074 Reserved - - Reserved
0x16004075 Reserved - - Reserved
0x16004076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 3

[Back to index | Back to parent block]
Address Name RW Default Description
0x16008000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16008001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16008002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16008003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16008004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16008005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16008006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16008007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16008008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16008009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1600800A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600800B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16008014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16008015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16008016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16008017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16008018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16008019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1600801A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1600801B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1600801C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600801D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1600801E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16008028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16008029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600802A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600802B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600802C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600802D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600802E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600802F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16008030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16008031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600803C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16008046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16008047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16008048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16008049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600804A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600804B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600804C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600804D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600804E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16008064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16008065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16008066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16008067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16008068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16008069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1600806A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1600806E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1600806F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16008070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16008071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16008072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16008073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16008074 Reserved - - Reserved
0x16008075 Reserved - - Reserved
0x16008076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 4

[Back to index | Back to parent block]
Address Name RW Default Description
0x1600C000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x1600C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x1600C002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x1600C003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x1600C004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x1600C005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x1600C006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x1600C007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x1600C008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x1600C009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1600C00A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600C00B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1600C014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x1600C015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x1600C016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x1600C017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x1600C018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x1600C019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1600C01A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1600C01B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1600C01C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1600C01D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1600C01E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x1600C028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C02A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C02B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C02C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C02D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C02E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C02F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1600C03C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x1600C046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C04A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C04B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C04C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C04D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C04E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1600C064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x1600C065 the time lag RO 0 Bits[31:0] = time lag as a float
0x1600C066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x1600C067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x1600C068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x1600C069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1600C06A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1600C06E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1600C06F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x1600C070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x1600C071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1600C072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1600C073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1600C074 Reserved - - Reserved
0x1600C075 Reserved - - Reserved
0x1600C076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 5

[Back to index | Back to parent block]
Address Name RW Default Description
0x16010000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16010001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16010002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16010003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16010004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16010005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16010006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16010007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16010008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16010009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1601000A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601000B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16010014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16010015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16010016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16010017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16010018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16010019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1601001A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1601001B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1601001C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601001D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1601001E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16010028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16010029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601002A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601002B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601002C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601002D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601002E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601002F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16010030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16010031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601003C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16010046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16010047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16010048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16010049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601004A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601004B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601004C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601004D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601004E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16010064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16010065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16010066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16010067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16010068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16010069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1601006A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1601006E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1601006F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16010070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16010071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16010072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16010073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16010074 Reserved - - Reserved
0x16010075 Reserved - - Reserved
0x16010076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 6

[Back to index | Back to parent block]
Address Name RW Default Description
0x16014000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16014001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16014002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16014003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16014004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16014005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16014006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16014007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16014008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16014009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1601400A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601400B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16014014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16014015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16014016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16014017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16014018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16014019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1601401A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1601401B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1601401C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601401D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1601401E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16014028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16014029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601402A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601402B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601402C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601402D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601402E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601402F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16014030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16014031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601403C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16014046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16014047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16014048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16014049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601404A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601404B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601404C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601404D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601404E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16014064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16014065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16014066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16014067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16014068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16014069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1601406A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1601406E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1601406F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16014070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16014071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16014072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16014073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16014074 Reserved - - Reserved
0x16014075 Reserved - - Reserved
0x16014076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 7

[Back to index | Back to parent block]
Address Name RW Default Description
0x16018000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16018001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16018002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16018003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16018004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16018005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16018006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16018007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16018008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16018009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1601800A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601800B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16018014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16018015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16018016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16018017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16018018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16018019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1601801A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1601801B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1601801C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601801D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1601801E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16018028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16018029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601802A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601802B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601802C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601802D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601802E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601802F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16018030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16018031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601803C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16018046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16018047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16018048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16018049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601804A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601804B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601804C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601804D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601804E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16018064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16018065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16018066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16018067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16018068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16018069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1601806A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1601806E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1601806F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16018070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16018071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16018072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16018073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16018074 Reserved - - Reserved
0x16018075 Reserved - - Reserved
0x16018076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 8

[Back to index | Back to parent block]
Address Name RW Default Description
0x1601C000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x1601C001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x1601C002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x1601C003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x1601C004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x1601C005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x1601C006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x1601C007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x1601C008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x1601C009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1601C00A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601C00B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1601C014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x1601C015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x1601C016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x1601C017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x1601C018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x1601C019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1601C01A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1601C01B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1601C01C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1601C01D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1601C01E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x1601C028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C02A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C02B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C02C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C02D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C02E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C02F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1601C03C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x1601C046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C04A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C04B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C04C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C04D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C04E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1601C064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x1601C065 the time lag RO 0 Bits[31:0] = time lag as a float
0x1601C066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x1601C067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x1601C068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x1601C069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1601C06A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1601C06E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1601C06F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x1601C070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x1601C071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1601C072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1601C073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x1601C074 Reserved - - Reserved
0x1601C075 Reserved - - Reserved
0x1601C076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 9

[Back to index | Back to parent block]
Address Name RW Default Description
0x16020000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16020001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16020002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16020003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16020004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16020005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16020006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16020007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16020008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16020009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1602000A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1602000B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16020014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16020015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16020016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16020017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16020018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16020019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1602001A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1602001B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1602001C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1602001D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1602001E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16020028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16020029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602002A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602002B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602002C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602002D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602002E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602002F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16020030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16020031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602003C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16020046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16020047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16020048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16020049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602004A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602004B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602004C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602004D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602004E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16020064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16020065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16020066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16020067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16020068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16020069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1602006A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1602006E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1602006F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16020070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16020071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16020072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16020073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16020074 Reserved - - Reserved
0x16020075 Reserved - - Reserved
0x16020076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : VMT entry 10

[Back to index | Back to parent block]
Address Name RW Default Description
0x16024000 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The visible master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
Note how register addresses change for entries 1,2 through to 10
0x16024001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the visible master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x16024002 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x16024003 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x16024004 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x16024005 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x16024006 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x16024007 The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x16024008 The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the visible master.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x16024009 The local ptp port number RO 0 Bits[31:8] = reserved
Bits[7:0] = ptp number (starting from 1)
0x1602400A Priority 1 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1602400B Priority 2 of visible master RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x16024014 The grand master's node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these two node id words in one go.
0x16024015 The grand master's node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the grand master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these two node id words in one go.
0x16024016 steps removed from grand master RO 0 Bits[31:8] = reserved
Bits[7:0] = steps removed value (from 0 to 255)
Notes: Number of steps removed this visible master has from the grand master.
0x16024017 The grand master's clock class RO 0 Bits[31:8] = reserved
Bits[7:0] = clock class (from 0 to 255)
force = 0,
primaryReference = 6,
secondaryReference = 7,
defaultLocked = 13,
holdoverClockClass = 14,
bestClockStratumThatCanBeSlave = 128,
reducedHoldoverClockClass = 193,
stratum3 = 248,
stratum4 = 254,
highestStratumThatCanBeMaster = 254,
defaultStratum = 255.
0x16024018 The grand master's clock source type RO 0 Bits[31:4] = reserved
Bits[3:0] = source
atom = 0,
gps = 1,
radio = 2,
ptp = 3,
ntp = 4,
handSet = 5,
other = 6,
internalOscillator = 7,
smpteArbFo = 8,
smpteF1 = 9.
0x16024019 The grand master's accuracy RO 0 Bits[31:8] = reserved
Bits[7:0] = accuracy (from 0 to 255)
NS25 = 0x20,
NS100 = 0x21,
NS250 = 0x22,
US1 = 0x23,
US2_5 = 0x24,
US10 = 0x25,
US25 = 0x26,
US100 = 0x27,
US250 = 0x28,
MS1 = 0x29,
MS2_5 = 0x2A,
MS10 = 0x2B,
MS25 = 0x2C,
MS100 = 0x2D,
MS250 = 0x2E,
S1 = 0x2F,
S10 = 0x30,
GT10S = 0x31,
ACC_UNKNOWN = 0xFE (The time accuracy is unknown)
Notes: Reference clock accuracy of the grand master. Values represent:
0x1602401A The grand master's log variance RO 0 Bits[31:16] = reserved
Bits[15:0] = log variance (from 0)
Notes: Reference clock log variance of the grand master. Value is a uint16 as defined in 1588 v2 7.6.3.3
0x1602401B The grand master's time valid value RO 0 Bits[31:1] = reserved
Bits[0:0] = time valid
0 = not TAI time,
1 = TAI time
0x1602401C The grand master's priority 1 RO 0 Bits[31:8] = reserved
Bits[7:0] = p1 value (from 0 to 255)
0x1602401D The grand master's priority 2 RO 0 Bits[31:8] = reserved
Bits[7:0] = p2 value (from 0 to 255)
0x1602401E The grand master's time transport RO 0 Bits[31:3] = reserved
Bits[2:0] = time transport value (from 0)
noTimeTransport = 0,
generatedLocally = 1,
viaPacketNetwork = 2,
viaWire = 3,
hybridSource = 4.
0x16024028 count of unicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16024029 count of multicast announce messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast announce messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602402A count of unicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602402B count of multicast sync messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast sync messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602402C count of unicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602402D count of multicast delay resp messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay resp messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602402E count of unicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602402F count of multicast delay req messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast delay req messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16024030 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the unicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x16024031 count of follow up messages received RO 0 Bits[31:0] = count (from 0)
Notes: Count of the multicast follow up messages received from the visible master
It is recommended to get all the *count of values* in one call.
0x1602403C reset statistics WO 0 Bits[31:1] = reserved
Bits[0:0] = any value.
Notes: This call will reset all the msg count statistics to zero
0x16024046 granted announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted announce messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16024047 granted sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted sync messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16024048 granted delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Granted delay req messages log period. This may differ from the value requested by the PTP port.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16024049 actual announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual announce messages log period. This may differ from the granted value.
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602404A actual sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual sync messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602404B actual delay req log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
Notes: Actual delay req messages log period. This may differ from the granted value
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602404C announce grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the announce grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602404D sync grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the sync grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x1602404E delay req grant remaining RO 0 Bits[31:0] = time in s
Notes: Amount of time in seconds remaining for the delay req grant
It is recommended to get the *granted xxx log period*, *actual xxx log period* and *xxx remaining* values in one call.
0x16024064 is the time lag valid RO 0 Bits[31:1] = reserved
Bits[0:0] = time lag valid
0 = time lag invalid,
1 = time lag valid
0x16024065 the time lag RO 0 Bits[31:0] = time lag as a float
0x16024066 estimated noise valid RO 0 Bits[31:1] = reserved
Bits[0:0] = valid
0 = invalid,
1 = valid
0x16024067 estimated noise in master to slave direction RO 0 Bits[31:0] = noise as a float
0x16024068 estimated noise in slave to master direction RO 0 Bits[31:0] = noise as a float
0x16024069 estimated packet delay in master to slave direction RO 0 Bits[31:0] = delay as a float
0x1602406A estimated packet delay in slave to master direction RO 0 Bits[31:0] = delay as a float
0x1602406E visible master state RO 0 Bits[31:3] = reserved
Bits[2..0] = state
0 invalidVM,
1 validatingVM,
2 tooFewTimingMessagesVM,
3 notOfInterestVM,
4 requestingContractVM,
5 validVM
0x1602406F wait to restore time remaining RO 0 Bits[31:0] = time in seconds
Notes: wait to restore is a feature where a potential master is prevented from becoming the selected
master for a configured time
0x16024070 master lock out RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable
1 = enable
Notes: if lock out is enabled then this master will not be considered as a potential master in the BMCA algorithm
0x16024071 multicast announce log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16024072 multicast sync log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16024073 multicast delay response log period RO 0 Bits[31:8] = reserved
Bits[7:0] = log period - log base 2 as an sint8
0x16024074 Reserved - - Reserved
0x16024075 Reserved - - Reserved
0x16024076 grand master local priority RW 0 Bits[31:8] = reserved
Bits[7:0] = local priority (from 0 to 255)

Visible Master Table 2 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x16FFC000 Visible masters' mask RO 0 Bits[31:0] = bit mask
Notes: Retrieves the bit mask of the visible masters, where each bit represents which visible master is there.
Eg if the mask = 0x3 this means the first two bits are set and so there are visible masters in the first two
locations.
0x16FFC001 grants issued change counter RO 0 Bits[31:0] = integer
Notes: This should be periodically called to keep a track of whether new grants have been issued.
eg if the value is different than the last time then this difference is the number of grants issued

PTP PLL 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x17000000 Source status
0x17004000 Source configuration
0x17008000 Source reference clock
0x1700C000 UTC Offset
0x17020000 Source Input
0x17028000 Holdover Controller
0x1702C000 Binary Lock Monitor
0x17030000 Frequency offset

PTP PLL 2 Configuration : Source status

[Back to index | Back to parent block]
Address Name RW Default Description
0x17000000 Source state RO 0 Bits[31:3] reserved
Bits[2:0] Source state. Valid values:
0 void. Empty
1 invalid. No time is available.
2 valid. Time is available but the source has not been selected.
3 measuring. The source has been selected and is measuring freq or phase offset.
4 holdover. The source has lost lock and is currently in holdover.
5 running. The source is providing time information.
0x17000001 Source phase lag error RO - Bits[31:0] Phase lag error expressed as a single precision floating point number
0x17000002 Source measured noise RO - Bits[31:0] Measured noise expressed as a single precision floating point number
This is the mean of noise in both directions
0x17000003 Source holdover validity RO - Bits[31:0] Holdover validity expressed as a single precision floating point number
0x17000004 Source lock value RO - Bits[31:0] Lock value expressed as a single precision floating point number
Range 0.0 to 1.0
0x17000005 Source locked state RO 0 Bits[31:1] Reserved
Bits[0] 0 - not locked, 1 - locked
0x17000006 Phase error gradient RO - Bits[31:0] Phase error gradient expressed as a single precision floating point number
This equals the frequency error of the PTP PLL with respect to its time source.
0x17000007 Source type RO - Bits[31:2] Reserved
Bits[1:0] 0 = Clock, 1 = Normal PTP, 2 = Hybrid PTP.
0x17000008 Phase output's accuracy (error range) RO 0 Bits[31:0] Phase output's accuracy is expressed as a single precision floating point number. Valid for Ptp source only.
Notes: This gives an estimate of the possible accuracy range of the phase output. Accuracy should always be a positive value. Value "0" means the accuracy estimate is not valid.
0x17000010 PTP PLL time secs bits 47 to 32 RO - Bits[31:16] = reserved
Bits[15:0] = PTP PLL time seconds bits 47 to 32 of 48 bit seconds field
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x17000011 PTP PLL time seconds bits 31 to 0 RO - Bits[31:0] = PTP PLL time seconds bits 31 to 0 of 48 bit seconds field
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x17000012 PTP PLL time nanoseconds RO - Bits[31:0] = PTP PLL time nanoseconds
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x17000013 PTP PLL time TAI flag RO - Bits[31:1] = reserved
Bits[0] = 1 is TAI flag is TRUE, 0 if FALSE
Notes: This parameter is consistent with the other PTP PLL time registers if read in the same api message
0x17000014 Reserved - - Reserved
0x17000020 Current value of input source Clock Class RO - Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
Note that this may not be the same as 0x17008002 if the source is in holdover.

PTP PLL 2 Configuration : Source configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x17004000 PTP PLL Unlocked Bandwidth RW 10.0e-3 Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x17004001 PTP PLL Locked Bandwidth RW 1.0e-3 Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x17004002 Frequency Measurement Duration RW 30 Bits[31:16] Reserved
Bits[15:0] Duration of the initial frequency measurement period in seconds
0x17004003 Frequency Measurement Minimum Packets RW 50 Bits[31:16] Reserved
Bits[15:0] The minimum number of packets to be used in the initial frequency measurement period.
0x17004004 Configured phase lag RW 0.0 Bits[31:0] Configured phase lag in seconds expressed as a single precision floating point number
0x17004005 Configured maximum phase error for phase jump RW 15e-6 Bits[31:0] Configured maximum phase error in seconds expressed as a single precision floating point number.
Notes: This parameter specifies the maximum phase error before the PTP slave does a phase jump to align with the master.
0x17004009 Minimum lock value to be master RW 0.1 Bits[31:0] Lock value expressed as a single precision floating point number
The minimum lock value for an input source used as a time reference on a PTP port for the port to enter master state
0x1700400A Enable fast calibration RW 0 Bits[31:1] Reserved
Bits[0] 1 = Enable, 0 = Disable
Notes: When enabled, TopSync will do fast calibration to align with the master in a very short period. This parameter should only be enabled when the network load is low and PTP packet rate is normal or high (32 pps or higher).
0x1700400B Reserved - - Reserved
0x1700400C Reserved - - Reserved
0x1700400D Reserved - - Reserved
0x1700400E Reserved - - Reserved
0x17004011 Reserved - - Reserved
0x1700400F Reserved - - Reserved
0x17004010 Reserved - - Reserved
0x17004014 Reserved - - Reserved
0x17004015 Reserved - - Reserved
0x17004016 Reserved - - Reserved
0x17004019 Reserved - - Reserved
0x1700401A Reserved - - Reserved
0x1700401B Reserved - - Reserved
0x1700401C PTP can be backup source to clock input such as GPS RW 0 Bits[31:1] Reserved
Bits[0] 1 = Can be, 0 = Can not be.
0x1700401E Reserved - - Reserved
0x1700401F Reserved - - Reserved
0x17004020 Time since last jump to align with the master RW - Bits[31:0] Unsigned integer in unit of second
Notes: Write to reset this register to indicate there is master jump. This register will increase one per second to record the time since last alignment with the master.
0x17004023 Phase buildout property for node time 1 RW 2 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Notes: The default value is different for PTP source and Clock source.
0x17004024 Phase buildout property for node time 2 RW 2 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Notes: The default value is different for PTP source and Clock source.
0x17004028 Lock detector's sensitivity multiple factor RW 1 Bits[31:0] Positive float value

PTP PLL 2 Configuration : Source reference clock

[Back to index | Back to parent block]
Address Name RW Default Description
0x17008000 Node ID bytes 0-3 RO 0 Bits[31:24] Node ID byte 0
Bits[23:16] Node ID byte 1
Bits[15:8] Node ID byte 2
Bits[7:0] Node ID byte 3
0x17008001 Node ID bytes 4-7 RO 0 Bits[31:24] Node ID byte 4
Bits[23:16] Node ID byte 5
Bits[15:8] Node ID byte 6
Bits[7:0] Node ID byte 7
0x17008002 Clock Class RO 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
0x17008003 Time Source RO 0 Bits[31:4] Reserved
Bits[3:0] Time source. Allowed values
000 Atomic clock
001 GPS
010 Terrestrial (radio)
011 PTP
100 NTP
101 Hand set
110 Other source
111 internalOscillator. No time reference at all
1000 smpte time source F0 (arb)
1001 smpte time source F1
0x17008004 Clock Accuracy RO 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock Accuracy. Allowed values:
0x20 NS25 The time is accurate to within 25 ns
0x21 NS100 The time is accurate to within 100 ns
0x22 NS250 The time is accurate to within 250 ns
0x23 US1 The time is accurate to within 1 us
0x24 US2_5 The time is accurate to within 2.5 us
0x25 US10 The time is accurate to within 10 us
0x26 US25 The time is accurate to within 25 us
0x27 US100 The time is accurate to within 100 us
0x28 US250 The time is accurate to within 250 us
0x29 MS1 The time is accurate to within 1 ms
0x2A MS2_5 The time is accurate to within 2.5 ms
0x2B MS10 The time is accurate to within 10 ms
0x2C MS25 The time is accurate to within 25 ms
0x2D MS100 The time is accurate to within 100 ms
0x2E MS250 The time is accurate to within 250 ms
0x2F S1 The time is accurate to within 1 s
0x30 S10 The time is accurate to within 10 s
0x31 GT10S The time is accurate to >10 s
0xFE ACC_UNKNOWN The time accuracy is unknown
0x17008005 Offset scaled log variance RO 0 Bits[31:16] Reserved
Bits[15:0] IEEE1588 Offset scaled log variance defined in 1588 v2 7.6.3.3
0x17008006 Time valid RO 0 Bits[31:1] Reserved
Bits[0] 1 - The time is a valid TAI time, 0 otherwise
0x17008007 Priority 1 value RO 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x17008008 Priority 2 value RO 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x17008009 Steps removed value RO 0 Bits[31:16] Reserved
Bits[15:0] Steps removed value
0x1700800A Local Priority value RO 0 Bits[31:8] Reserved
Bits[7:0] Local Priority value

PTP PLL 2 Configuration : UTC Offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x1700C000 UTC Offset Value RO 0 Bits[31:0] UTC Offset value as a signed integer. Valid range covers bits 15:0 only
Notes: if the PTP port does not have a source selected this value is invalid
0x1700C001 UTC Offset Value RO 0 Bits[31:1] Reserved
Bits[0] 1 UTC Offset value is valid, 0 UTC Offset value is invalid
Notes: if the PTP port does not have a source selected this value is invalid
0x1700C004 Days to leap second RO 0 Bits[31:0] Number of days as a signed integer. Valid range covers bits 15:0 only
If leap second will happen at the next midnight (UTC time) number of days = 0.
If leap second will happen at tomorrow's midnight (UTC time) number of days = 1.
Number of days must not be greater than MAX_WARNING_DAYS.
Setting this value to <0 will clear any pending leap second
It is advised to set this and the following register in one write operation.
Notes: if the PTP port does not have a source selected this value is invalid
0x1700C005 Leap second is positive RO 0 Bits[31:1] Reserved
Bits[0] 1 leap second jump is positive, 0 leap second jump is negative
It is advised to set this and the previous register in one write operation.
Notes: if the PTP port does not have a source selected this value is invalid

PTP PLL 2 Configuration : Source Input

[Back to index | Back to parent block]
Address Name RW Default Description
0x17020000 Input Source Exists RO 0 Bits[31:1] reserved
Bits[0] Input source exists:
1 - PTP PLL has input from an external source.
0 - PTP PLL has no current input
0x17020001 Visible Master Index RO 0xffffffff Bits[31:0] Index of current input source in visible master table
If PTP PLL has no current input the value is 0xffffffff
0x17020002 Input State RO - Bits[31:2] reserved
Bits[1:0] Input state of PTP PLL. Valid values:
00 Estimating frequency offset
01 Estimating phase offset.
10 Running.
0x17020003 Clock input mux to select LO or clock PLL for freq input RW 0 Bits[31:3] Reserved
Bits[2:0] Valid values (Other values are reserved):
0 - Local oscillator for frequency
1 - Clock PLL1 used as frequency input
2 - Clock PLL2 used as frequency input
0x17020004 Clock input is coherent RW 1 Bits[31:1] Reserved
Bits[0] 1 = Is coherent, 0 = Not coherent, or congruent
0x17020005 Reserved - - Reserved
0x17020006 Use configured PLL bandwdith RW 0 Bits[31:1] Reserved
Bits[0] 1 = Use Configured bandwdith, 0 = Use internal default bandwidth
Notes: this parameter may be set to TRUE for operation of Hybrid in Boundary Clock case.
0x1702000A Reserved - - Reserved
0x1702000B Reserved - - Reserved

PTP PLL 2 Configuration : Holdover Controller

[Back to index | Back to parent block]
Address Name RW Default Description
0x17028000 Holdover Duration RW 3600 Bits[31:0] Duration value as a unsigned integer.
0x17028001 Reset WO 0 Bits[31:1] = reserved
Bits[0] = any value.
Notes: This resets the holdover data used to maintain effective holdover in the absence
of an input source. It does not force the PLL to exit the holdover state and should not
be used when the PLL is in holdover
0x17028002 Disable/enable forceHoldover RW 0 Bits[31:1] = reserved
Bits[0] = 1 - ForceHoldover enabled, 0 - disabled
0x17028003 clock class on entering holdover RW 14 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value on entering holdover
0x17028004 clock class after holdover duration RW 193 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value after the holdover duration has expired
0x17028005 packet noise level triggering holdover state RW 10.0e-6 Bits[31:0] = positive float value
Notes: The valid minimum value for this parameter is 1.0e-6
0x17028006 Use local node ID for GM ID in holdover RW 0 Bits[31:1] = reserved
Bits[0] = 0 Keep previous GM (external) ID in holdover (default)
= 1 Change transmitted GM ID in PTP messages to local node ID in holdover

PTP PLL 2 Configuration : Binary Lock Monitor

[Back to index | Back to parent block]
Address Name RW Default Description
0x1702C000 Binary error acceptable RW 1.0e-6 Bits[31:0] value as a float value.
0x1702C001 Binary error unacceptable RW 5.0e-6 Bits[31:0] value as a float value.
0x1702C002 Binary error gradient acceptable RW 1.0e-9 Bits[31:0] value as a float value.
0x1702C003 Binary error gradient unaccpetable RW 2.5e-9 Bits[31:0] value as a float value.
0x1702C004 Binary fuzzy lock acceptable RW 0.5 Bits[31:0] value as a float value.
0x1702C005 Binary fuzzy lock unacceptable RW 0.25 Bits[31:0] value as a float value.
0x1702C006 Binary force lock RW 0 Bits[31:2] reserved.
Bits[1:0] 2 = Forced to UnLocked State, 1 = Forced to Locked State, 0 = Not Forced
0x1702C007 Binary maintain lock during source switch RW 0 Bits[31:1] reserved.
Bits[0] 1 = Maintain Lock, 0 = Not Maintain Lock
0x1702C008 Reserved - - Reserved
0x1702C009 Reserved - - Reserved

PTP PLL 2 Configuration : Frequency offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x17030000 Clock PLL max frequency offset RW 0 Bits[31:0] Max frequency offset in Hz expressed as a single precision floating point number
Value in Hz
0x17030001 Clock PLL CURRENT frequency offset RO 0 Bits[31:0] frequency offset in Hz expressed as a single precision floating point number
Value in Hz

Acceptable Slave Table 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x1E000000 AST entry
0x1E004000 AST entry
0x1E008000 AST entry
0x1E00C000 AST entry
0x1E010000 AST entry
0x1E014000 AST entry
0x1E018000 AST entry
0x1E01C000 AST entry
0x1E020000 AST entry
0x1E024000 AST entry
0x1EFF8000 AST entry
0x1EFFC000 General Parameters

Acceptable Slave Table 1 Configuration : AST entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x1E000000 Reserved - - Reserved
0x1E000001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either AST_ENTRY_TPA_ADDRESS_1 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1E000002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1E000003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1E000004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1E000005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1E000006 The acceptable slave's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1E000007 The acceptable slave's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1E000008 The acceptable slave's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable slave. This values starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFF then this means that the
acceptable master entry is not in use.
0x1E000009 Priority 1 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1E00000A Priority 2 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1E00000B forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable
Notes:Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without requiring the usual
process of establishing a contract through the exchange of signalling messages.
Setting this bit causes the master to send announce and sync messages to the specified slave and to respond to delay request
messages received from that slave without any negotiation.
This mechanism should be enabled when the acceptable slave entry field 'enabled' is FALSE. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started.
0x1E00000C forced grant announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Sets the forced grant announce log period. This is the log period of the announce message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the announce messages are sent at this log period value.
0x1E00000D forced grant sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = sync log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant sync log period. This is the log period of the sync message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the sync messages are sent at this log period value.
0x1E00000E forced grant delay response log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay response log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant delay response log period. This is the log period of the delay response message to be
sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the delay response messages are sent at this log period value.
0x1E000020 enable unicast announces when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast announce messages when forced grant is enabled
0 = disable unicast announce messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1E000021 enable unicast syncs when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast sync messages when forced grant is enabled
0 = disable unicast sync messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1E000022 enable unicast delay responses when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast delay response messages when forced grant is enabled
0 = disable unicast delay response messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1E000080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable
Notes: Enables this acceptable slave entry to be used.
When this is enabled the slave can now be used as an acceptable slave. If disabled then this means that slave cannot
be considered as an acceptable slave. To configure any of the values described in this slave entry then it is strongly
recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in
unexpected behaviour.

Acceptable Slave Table 1 Configuration : AST entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x1E004000 Reserved - - Reserved
0x1E004001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either AST_ENTRY_TPA_ADDRESS_1 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1E004002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1E004003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1E004004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1E004005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1E004006 The acceptable slave's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1E004007 The acceptable slave's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1E004008 The acceptable slave's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable slave. This values starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFF then this means that the
acceptable master entry is not in use.
0x1E004009 Priority 1 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1E00400A Priority 2 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1E00400B forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable
Notes:Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without requiring the usual
process of establishing a contract through the exchange of signalling messages.
Setting this bit causes the master to send announce and sync messages to the specified slave and to respond to delay request
messages received from that slave without any negotiation.
This mechanism should be enabled when the acceptable slave entry field 'enabled' is FALSE. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started.
0x1E00400C forced grant announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Sets the forced grant announce log period. This is the log period of the announce message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the announce messages are sent at this log period value.
0x1E00400D forced grant sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = sync log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant sync log period. This is the log period of the sync message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the sync messages are sent at this log period value.
0x1E00400E forced grant delay response log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay response log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant delay response log period. This is the log period of the delay response message to be
sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the delay response messages are sent at this log period value.
0x1E004020 enable unicast announces when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast announce messages when forced grant is enabled
0 = disable unicast announce messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1E004021 enable unicast syncs when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast sync messages when forced grant is enabled
0 = disable unicast sync messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1E004022 enable unicast delay responses when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast delay response messages when forced grant is enabled
0 = disable unicast delay response messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1E004080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable
Notes: Enables this acceptable slave entry to be used.
When this is enabled the slave can now be used as an acceptable slave. If disabled then this means that slave cannot
be considered as an acceptable slave. To configure any of the values described in this slave entry then it is strongly
recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in
unexpected behaviour.

Acceptable Slave Table 1 Configuration : AST entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x1EFF8000 Reserved - - Reserved
0x1EFF8001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either AST_ENTRY_TPA_ADDRESS_1 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1EFF8002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1EFF8003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1EFF8004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1EFF8005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1EFF8006 The acceptable slave's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1EFF8007 The acceptable slave's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1EFF8008 The acceptable slave's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable slave. This values starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFF then this means that the
acceptable master entry is not in use.
0x1EFF8009 Priority 1 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1EFF800A Priority 2 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1EFF800B forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable
Notes:Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without requiring the usual
process of establishing a contract through the exchange of signalling messages.
Setting this bit causes the master to send announce and sync messages to the specified slave and to respond to delay request
messages received from that slave without any negotiation.
This mechanism should be enabled when the acceptable slave entry field 'enabled' is FALSE. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started.
0x1EFF800C forced grant announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Sets the forced grant announce log period. This is the log period of the announce message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the announce messages are sent at this log period value.
0x1EFF800D forced grant sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = sync log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant sync log period. This is the log period of the sync message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the sync messages are sent at this log period value.
0x1EFF800E forced grant delay response log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay response log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant delay response log period. This is the log period of the delay response message to be
sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the delay response messages are sent at this log period value.
0x1EFF8020 enable unicast announces when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast announce messages when forced grant is enabled
0 = disable unicast announce messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1EFF8021 enable unicast syncs when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast sync messages when forced grant is enabled
0 = disable unicast sync messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1EFF8022 enable unicast delay responses when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast delay response messages when forced grant is enabled
0 = disable unicast delay response messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1EFF8080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable
Notes: Enables this acceptable slave entry to be used.
When this is enabled the slave can now be used as an acceptable slave. If disabled then this means that slave cannot
be considered as an acceptable slave. To configure any of the values described in this slave entry then it is strongly
recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in
unexpected behaviour.

Acceptable Slave Table 1 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x1EFFC000 enable the AST table RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the acceptable slave table
0x1EFFC001 validity of entries 1..32 RO 0 Bits[31:0] = bitfield
Notes: if entry 1 is valid then bit 0 in this field is 1, if entry 32 is valid then
bit 31 is 1 etc
0x1EFFC002 validity of entries 33..64 RO 0 Bits[31:0] = bitfield
Notes: if entry 33 is valid then bit 0 in this field is 1, if entry 64 is valid then
bit 31 is 1 etc
0x1EFFC003 validity of entries 65..96 RO 0 Bits[31:0] = bitfield
Notes: if entry 65 is valid then bit 0 in this field is 1, if entry 96 is valid then
bit 31 is 1 etc
0x1EFFC004 validity of entries 97..128 RO 0 Bits[31:0] = bitfield
Notes: if entry 97 is valid then bit 0 in this field is 1, if entry 128 is valid then
bit 31 is 1 etc
0x1EFFC005 validity of entries 129..160 RO 0 Bits[31:0] = bitfield
Notes: if entry 129 is valid then bit 0 in this field is 1, if entry 160 is valid then
bit 31 is 1 etc
0x1EFFC006 validity of entries 161..192 RO 0 Bits[31:0] = bitfield
Notes: if entry 161 is valid then bit 0 in this field is 1, if entry 192 is valid then
bit 31 is 1 etc
0x1EFFC007 validity of entries 193..224 RO 0 Bits[31:0] = bitfield
Notes: if entry 193 is valid then bit 0 in this field is 1, if entry 224 is valid then
bit 31 is 1 etc
0x1EFFC008 validity of entries 225..256 RO 0 Bits[31:0] = bitfield
Notes: if entry 225 is valid then bit 0 in this field is 1, if entry 256 is valid then
bit 31 is 1 etc. Note that these bitfields are continued for the full 1023 slaves that can be held in the
AST.
0x1EFFC020 validity of entries 993..1023 RO 0 Bits[31:0] = bitfield
Notes: if entry 993 is valid then bit 0 in this field is 1, if entry 1023 is valid then
bit 30 is 1 etc.

Acceptable Slave Table 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x1F000000 AST entry
0x1F004000 AST entry
0x1F008000 AST entry
0x1F00C000 AST entry
0x1F010000 AST entry
0x1F014000 AST entry
0x1F018000 AST entry
0x1F01C000 AST entry
0x1F020000 AST entry
0x1F024000 AST entry
0x1FFF8000 AST entry
0x1FFFC000 General Parameters

Acceptable Slave Table 2 Configuration : AST entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x1F000000 Reserved - - Reserved
0x1F000001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either AST_ENTRY_TPA_ADDRESS_1 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1F000002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1F000003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1F000004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1F000005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1F000006 The acceptable slave's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1F000007 The acceptable slave's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1F000008 The acceptable slave's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable slave. This values starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFF then this means that the
acceptable master entry is not in use.
0x1F000009 Priority 1 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1F00000A Priority 2 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1F00000B forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable
Notes:Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without requiring the usual
process of establishing a contract through the exchange of signalling messages.
Setting this bit causes the master to send announce and sync messages to the specified slave and to respond to delay request
messages received from that slave without any negotiation.
This mechanism should be enabled when the acceptable slave entry field 'enabled' is FALSE. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started.
0x1F00000C forced grant announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Sets the forced grant announce log period. This is the log period of the announce message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the announce messages are sent at this log period value.
0x1F00000D forced grant sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = sync log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant sync log period. This is the log period of the sync message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the sync messages are sent at this log period value.
0x1F00000E forced grant delay response log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay response log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant delay response log period. This is the log period of the delay response message to be
sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the delay response messages are sent at this log period value.
0x1F000020 enable unicast announces when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast announce messages when forced grant is enabled
0 = disable unicast announce messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1F000021 enable unicast syncs when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast sync messages when forced grant is enabled
0 = disable unicast sync messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1F000022 enable unicast delay responses when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast delay response messages when forced grant is enabled
0 = disable unicast delay response messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1F000080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable
Notes: Enables this acceptable slave entry to be used.
When this is enabled the slave can now be used as an acceptable slave. If disabled then this means that slave cannot
be considered as an acceptable slave. To configure any of the values described in this slave entry then it is strongly
recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in
unexpected behaviour.

Acceptable Slave Table 2 Configuration : AST entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x1F004000 Reserved - - Reserved
0x1F004001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either AST_ENTRY_TPA_ADDRESS_1 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1F004002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1F004003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1F004004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1F004005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1F004006 The acceptable slave's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1F004007 The acceptable slave's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1F004008 The acceptable slave's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable slave. This values starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFF then this means that the
acceptable master entry is not in use.
0x1F004009 Priority 1 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1F00400A Priority 2 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1F00400B forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable
Notes:Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without requiring the usual
process of establishing a contract through the exchange of signalling messages.
Setting this bit causes the master to send announce and sync messages to the specified slave and to respond to delay request
messages received from that slave without any negotiation.
This mechanism should be enabled when the acceptable slave entry field 'enabled' is FALSE. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started.
0x1F00400C forced grant announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Sets the forced grant announce log period. This is the log period of the announce message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the announce messages are sent at this log period value.
0x1F00400D forced grant sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = sync log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant sync log period. This is the log period of the sync message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the sync messages are sent at this log period value.
0x1F00400E forced grant delay response log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay response log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant delay response log period. This is the log period of the delay response message to be
sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the delay response messages are sent at this log period value.
0x1F004020 enable unicast announces when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast announce messages when forced grant is enabled
0 = disable unicast announce messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1F004021 enable unicast syncs when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast sync messages when forced grant is enabled
0 = disable unicast sync messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1F004022 enable unicast delay responses when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast delay response messages when forced grant is enabled
0 = disable unicast delay response messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1F004080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable
Notes: Enables this acceptable slave entry to be used.
When this is enabled the slave can now be used as an acceptable slave. If disabled then this means that slave cannot
be considered as an acceptable slave. To configure any of the values described in this slave entry then it is strongly
recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in
unexpected behaviour.

Acceptable Slave Table 2 Configuration : AST entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x1FFF8000 Reserved - - Reserved
0x1FFF8001 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the acceptable slave's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
This length will be zero until either AST_ENTRY_TPA_ADDRESS_1 has been set when the ptp port is configured or when
the record has been enabled. In these cases it will calculate the value depending on
the ptp port configuration's protocol.
0x1FFF8002 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to set all of these six transmission protocol words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFF then this means that the
acceptable master entry is not in use.
0x1FFF8003 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to set all of these six transmission protocol words in one go.
0x1FFF8004 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to set all of these six transmission protocol words in one go.
0x1FFF8005 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the acceptable slave's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to set all of these six transmission protocol words in one go.
0x1FFF8006 The acceptable slave's port id node id bytes 0..3 RW 0xFFFFFFFF Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1FFF8007 The acceptable slave's port id node id bytes 4..7 RW 0xFFFFFFFF Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the acceptable slave's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFFFFFF then this means that the
acceptable master entry is not in use.
0x1FFF8008 The acceptable slave's port id ptp port number RW 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 1)
Notes: Ptp port number of the acceptable slave. This values starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to set all of these three port id words in one go.
If all the address words are set to zero and all of the nodeid words are set to 0xFFFF then this means that the
acceptable master entry is not in use.
0x1FFF8009 Priority 1 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 1
Notes: Priority 1 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1FFF800A Priority 2 of the acceptable slave RW 0 Bits[31:8] = reserved
Bits[7:0] = Priority 2
Notes: Priority 2 of the acceptable slave. In comparing reference clocks lower values are deemed to be
better sources than higher. Value can go from 0 to 255.
0x1FFF800B forced grant flag RW 0 Bits[31:1] = reserved
Bits[0:0] = forced grant
0 = disable,
1 = enable
Notes:Enables or disables the forced grant mechanism.
The forced grant mode of operation allows unicast operation between a master and a slave without requiring the usual
process of establishing a contract through the exchange of signalling messages.
Setting this bit causes the master to send announce and sync messages to the specified slave and to respond to delay request
messages received from that slave without any negotiation.
This mechanism should be enabled when the acceptable slave entry field 'enabled' is FALSE. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the forced grant mechanism is started.
0x1FFF800C forced grant announce log period RW 0 Bits[31:8] = reserved
Bits[7:0] = announce log period - log base 2 as an sint8 (value can go from 6 to -4)
Notes: Sets the forced grant announce log period. This is the log period of the announce message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the announce messages are sent at this log period value.
0x1FFF800D forced grant sync log period RW 0 Bits[31:8] = reserved
Bits[7:0] = sync log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant sync log period. This is the log period of the sync message to be
sent from the master to the acceptable slave
This value should be set while this acceptable slave entry is disabled. When this slave entry is enabled then
the forced grant flag is checked and if it is TRUE then the sync messages are sent at this log period value.
0x1FFF800E forced grant delay response log period RW 0 Bits[31:8] = reserved
Bits[7:0] = delay response log period - log base 2 as an sint8 (value can go from 4 to -7)
Notes: Sets the forced grant delay response log period. This is the log period of the delay response message to be
sent from the slave to the acceptable master.
This value should be set while this acceptable master entry is disabled. When this master entry is enabled then
the forced grant flag is checked and if it is TRUE then the delay response messages are sent at this log period value.
0x1FFF8020 enable unicast announces when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast announce messages when forced grant is enabled
0 = disable unicast announce messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1FFF8021 enable unicast syncs when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast sync messages when forced grant is enabled
0 = disable unicast sync messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1FFF8022 enable unicast delay responses when forced grant is enabled RW 0x1 Bits[31:1] = reserved
Bits[0:0] = flag
1 = enable unicast delay response messages when forced grant is enabled
0 = disable unicast delay response messages when forced grant is enabled
Notes: ToPSync will not send unicast messages when the PTP port address mode is multicastOnly.
0x1FFF8080 enable entry RW 0 Bits[31:1] = reserved
Bits[0:0] = enable record.
0 = disable,
1 = enable
Notes: Enables this acceptable slave entry to be used.
When this is enabled the slave can now be used as an acceptable slave. If disabled then this means that slave cannot
be considered as an acceptable slave. To configure any of the values described in this slave entry then it is strongly
recommended to firstly disable the record, change the settings, then enable the record, otherwise it may result in
unexpected behaviour.

Acceptable Slave Table 2 Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x1FFFC000 enable the AST table RW 0 Bits[31:1] = reserved
Bits[0:0] = enable
0 = disable,
1 = enable
Notes: Enables the acceptable slave table
0x1FFFC001 validity of entries 1..32 RO 0 Bits[31:0] = bitfield
Notes: if entry 1 is valid then bit 0 in this field is 1, if entry 32 is valid then
bit 31 is 1 etc
0x1FFFC002 validity of entries 33..64 RO 0 Bits[31:0] = bitfield
Notes: if entry 33 is valid then bit 0 in this field is 1, if entry 64 is valid then
bit 31 is 1 etc
0x1FFFC003 validity of entries 65..96 RO 0 Bits[31:0] = bitfield
Notes: if entry 65 is valid then bit 0 in this field is 1, if entry 96 is valid then
bit 31 is 1 etc
0x1FFFC004 validity of entries 97..128 RO 0 Bits[31:0] = bitfield
Notes: if entry 97 is valid then bit 0 in this field is 1, if entry 128 is valid then
bit 31 is 1 etc
0x1FFFC005 validity of entries 129..160 RO 0 Bits[31:0] = bitfield
Notes: if entry 129 is valid then bit 0 in this field is 1, if entry 160 is valid then
bit 31 is 1 etc
0x1FFFC006 validity of entries 161..192 RO 0 Bits[31:0] = bitfield
Notes: if entry 161 is valid then bit 0 in this field is 1, if entry 192 is valid then
bit 31 is 1 etc
0x1FFFC007 validity of entries 193..224 RO 0 Bits[31:0] = bitfield
Notes: if entry 193 is valid then bit 0 in this field is 1, if entry 224 is valid then
bit 31 is 1 etc
0x1FFFC008 validity of entries 225..256 RO 0 Bits[31:0] = bitfield
Notes: if entry 225 is valid then bit 0 in this field is 1, if entry 256 is valid then
bit 31 is 1 etc. Note that these bitfields are continued for the full 1023 slaves that can be held in the
AST.
0x1FFFC020 validity of entries 993..1023 RO 0 Bits[31:0] = bitfield
Notes: if entry 993 is valid then bit 0 in this field is 1, if entry 1023 is valid then
bit 30 is 1 etc.

Network Master Table Configuration : Sub Blocks

[Back to index]
Start Address Description
0x22000000 NMT entry
0x22004000 NMT entry
0x22008000 NMT entry
0x2200C000 NMT entry
0x22010000 NMT entry
0x22014000 NMT entry
0x22018000 NMT entry
0x2201C000 NMT entry
0x22020000 NMT entry
0x22024000 NMT entry
0x227FC000 NMT entry
0x22FFC000 General Parameters

Network Master Table Configuration : NMT entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x22000000 master record is active RO 0 Bits[31:1] = reserved
Bits[1:0] = active
0 = record has not been used
1 = record has a master's details
Note how the register addresses change for entries 1,2 up to the 32nd entry
0x22000001 receiving physical MAC RO 0 Bits[31:1] = reserved
Bits[0:0] = destination mac
0 or 1
Notes:The physical MAC interface that received the message
0x22000002 Reserved - - Reserved
0x22000003 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
0x22000004 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x22000005 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x22000006 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x22000007 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x22000008 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x22000009 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x2200000A The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x2200000B The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 0)
Notes: Ptp port number of the master. This value starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x2200000C IEEE1588 receive time secs bits 47 to 32 RO 0 Bits[31:16] = reserved
Bits[15:0] = seconds bits 47 to 32
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x2200000D IEEE1588 receive time in secs bits 31 to 0 RO 0 Bits[31:0] = seconds bits 31 to 0
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x2200000E IEEE1588 receive time in nsecs RO 0 Bits[31:0] = nano seconds
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x2200000F IEEE1588 receive time negative RO 0 Bits[31:1] = reserved
Bits[0:0] = negative
0 = positive time
1 = negative time
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x22000010 master's domain RO 0 Bits[31:8] = reserved
Bits[7:0] = domain
Notes: This is ptp domain of the master from 0 to 255
0x22000011 master's ptp verson RO 0 Bits[31:8] = reserved
Bits[7:0] = version
Notes: This is ptp version of the master
0x22000012 announce msg data bytes 0..3 RO 0 Bits[31:0] = announce msg data
Notes: This is the first 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22000013 announce msg data bytes 4..7 RO 0 Bits[31:0] = announce msg data
Notes: This is the second 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22000014 announce msg data bytes 8..11 RO 0 Bits[31:0] = announce msg data
Notes: This is the third 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22000015 announce msg data bytes 12..15 RO 0 Bits[31:0] = announce msg data
Notes: This is the fourth 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22000016 announce msg data byte 16 RO 0 Bits[31:24] = announce msg data
Notes: This is the last byte of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
Bits[23:0] = reserved
0x22000017 announce msg of flag RO 0 Bits[31:16] = reserved
Bits[15:0] = flag of announce message
0x22000018 announce msg of UTC_OFFSET RO 0 Bits[31:16] = reserved
Bits[15:0] = utc offset of announce message

Network Master Table Configuration : NMT entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x22004000 master record is active RO 0 Bits[31:1] = reserved
Bits[1:0] = active
0 = record has not been used
1 = record has a master's details
Note how the register addresses change for entries 1,2 up to the 32nd entry
0x22004001 receiving physical MAC RO 0 Bits[31:1] = reserved
Bits[0:0] = destination mac
0 or 1
Notes:The physical MAC interface that received the message
0x22004002 Reserved - - Reserved
0x22004003 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
0x22004004 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x22004005 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x22004006 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x22004007 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x22004008 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x22004009 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x2200400A The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x2200400B The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 0)
Notes: Ptp port number of the master. This value starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x2200400C IEEE1588 receive time secs bits 47 to 32 RO 0 Bits[31:16] = reserved
Bits[15:0] = seconds bits 47 to 32
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x2200400D IEEE1588 receive time in secs bits 31 to 0 RO 0 Bits[31:0] = seconds bits 31 to 0
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x2200400E IEEE1588 receive time in nsecs RO 0 Bits[31:0] = nano seconds
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x2200400F IEEE1588 receive time negative RO 0 Bits[31:1] = reserved
Bits[0:0] = negative
0 = positive time
1 = negative time
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x22004010 master's domain RO 0 Bits[31:8] = reserved
Bits[7:0] = domain
Notes: This is ptp domain of the master from 0 to 255
0x22004011 master's ptp verson RO 0 Bits[31:8] = reserved
Bits[7:0] = version
Notes: This is ptp version of the master
0x22004012 announce msg data bytes 0..3 RO 0 Bits[31:0] = announce msg data
Notes: This is the first 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22004013 announce msg data bytes 4..7 RO 0 Bits[31:0] = announce msg data
Notes: This is the second 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22004014 announce msg data bytes 8..11 RO 0 Bits[31:0] = announce msg data
Notes: This is the third 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22004015 announce msg data bytes 12..15 RO 0 Bits[31:0] = announce msg data
Notes: This is the fourth 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x22004016 announce msg data byte 16 RO 0 Bits[31:24] = announce msg data
Notes: This is the last byte of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
Bits[23:0] = reserved
0x22004017 announce msg of flag RO 0 Bits[31:16] = reserved
Bits[15:0] = flag of announce message
0x22004018 announce msg of UTC_OFFSET RO 0 Bits[31:16] = reserved
Bits[15:0] = utc offset of announce message

Network Master Table Configuration : NMT entry

[Back to index | Back to parent block]
Address Name RW Default Description
0x227FC000 master record is active RO 0 Bits[31:1] = reserved
Bits[1:0] = active
0 = record has not been used
1 = record has a master's details
Note how the register addresses change for entries 1,2 up to the 32nd entry
0x227FC001 receiving physical MAC RO 0 Bits[31:1] = reserved
Bits[0:0] = destination mac
0 or 1
Notes:The physical MAC interface that received the message
0x227FC002 Reserved - - Reserved
0x227FC003 Transmission protocol RO 0 Bits[31:2] = reserved
Bits[1:0] = protocol
0 = udp4,
1 = ethernet,
2 = udp6
Notes: The master's transmission protocol.
It is recommended to get all of these six transmission protocol words in one go.
0x227FC004 Transmission protocol address length RO 0 Bits[31:5] = reserved
Bits[4:0] = length
4 = udp4,
6 = ethernet,
16 = udp6
Notes: The length of the master's protocol address in bytes.
For udp4 addresses the length is usually 4 bytes.
For ethernet addresses the length is usually 6 bytes.
For udp6 addresses the length is usually 16 bytes.
It is recommended to get all of these six transmission protocol words in one go.
0x227FC005 Transmission protocol address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the address.
Notes: The master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
It is recommended to get all of these six transmission protocol words in one go.
0x227FC006 Transmission protocol address bytes 4..7 RO 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: The second set of 4 bytes in the master's protocol address
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
It is recommended to get all of these six transmission protocol words in one go.
0x227FC007 Transmission protocol address bytes 8..11 RO 0 Bits[31:0] = The third set of 4 bytes of the address.
Notes: The third set of 4 bytes in the master's protocol address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
It is recommended to get all of these six transmission protocol words in one go.
0x227FC008 Transmission protocol address bytes 12..15 RO 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Notes: The fourth set of 4 bytes in the master's protocol address in big endian.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
It is recommended to get all of these six transmission protocol words in one go.
0x227FC009 The master's portid node id bytes 0..3 RO 0x0 Bits[31:0] = The first set of 4 bytes of the node id
Notes: The first set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0x00, the LSB in the word will be 0xff.
It is recommended to get all of these three port id words in one go.
0x227FC00A The master's portid node id bytes 4..7 RO 0x0 Bits[31:0] = The second set of 4 bytes of the node id
Notes: The second set of 4 bytes in the master's node id
Each byte in this uint32 will be a value in the address. eg
In the node id 00:16:c0:ff:fe:11:00:01, the MSB in the word will be 0xfe, the LSB in the word will be 0x01.
It is recommended to get all of these three port id words in one go.
0x227FC00B The master's portid ptp port number RO 0xFFFF Bits[31:16] = reserved
Bits[15:0] = ptp number (starting from 0)
Notes: Ptp port number of the master. This value starts from zero.
A value of 0xFFFF acts as a wildcard.
It is recommended to get all of these three port id words in one go.
0x227FC00C IEEE1588 receive time secs bits 47 to 32 RO 0 Bits[31:16] = reserved
Bits[15:0] = seconds bits 47 to 32
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x227FC00D IEEE1588 receive time in secs bits 31 to 0 RO 0 Bits[31:0] = seconds bits 31 to 0
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x227FC00E IEEE1588 receive time in nsecs RO 0 Bits[31:0] = nano seconds
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x227FC00F IEEE1588 receive time negative RO 0 Bits[31:1] = reserved
Bits[0:0] = negative
0 = positive time
1 = negative time
Notes: This is the IEEE1588 time that the announce msg was received.
It is recommended to get all of these four IEEE1588 words in one go.
0x227FC010 master's domain RO 0 Bits[31:8] = reserved
Bits[7:0] = domain
Notes: This is ptp domain of the master from 0 to 255
0x227FC011 master's ptp verson RO 0 Bits[31:8] = reserved
Bits[7:0] = version
Notes: This is ptp version of the master
0x227FC012 announce msg data bytes 0..3 RO 0 Bits[31:0] = announce msg data
Notes: This is the first 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x227FC013 announce msg data bytes 4..7 RO 0 Bits[31:0] = announce msg data
Notes: This is the second 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x227FC014 announce msg data bytes 8..11 RO 0 Bits[31:0] = announce msg data
Notes: This is the third 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x227FC015 announce msg data bytes 12..15 RO 0 Bits[31:0] = announce msg data
Notes: This is the fourth 4 bytes of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
0x227FC016 announce msg data byte 16 RO 0 Bits[31:24] = announce msg data
Notes: This is the last byte of the received announce msg taken from offset
47 of the msg. In total there are 17 bytes that are taken.
It is recommended to get all these announce msg data in one go
Bits[23:0] = reserved
0x227FC017 announce msg of flag RO 0 Bits[31:16] = reserved
Bits[15:0] = flag of announce message
0x227FC018 announce msg of UTC_OFFSET RO 0 Bits[31:16] = reserved
Bits[15:0] = utc offset of announce message

Network Master Table Configuration : General Parameters

[Back to index | Back to parent block]
Address Name RW Default Description
0x22FFC000 reset network master table WO 0 Bits[31:0] = reserved
Notes: This will clear all the data in the network master table.
0x22FFC001 domain bit field for domains 1..31 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here. eg if this value = 0x7 then this means the user wants to accept entries with domains equal to
0, 1 or 2.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC002 domain bit field for domains 32..63 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC003 domain bit field for domains 64..95 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC004 domain bit field for domains 96..127 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC005 domain bit field for domains 128..159 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC006 domain bit field for domains 160..191 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC007 domain bit field for domains 192..223 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC008 domain bit field for domains 224..255 RW 0 Bits[31:0] = Domain bitfield
Notes: if the user wants to filter the NMT based on domain then he can set the domain bitfield
array here.
If all the bits in the domain bitfield are zero then filtering on domain is not used.
0x22FFC010 nmt change counter RO 0 Bits[31:0] = integer
Notes: Every time a new master comes online or a master is replaced then this counter
is incremented. It should be checked periodically and if changed then the user can read
this new master's details
0x22FFC011 nmt master bitfield 1 RO 0 Bits[31:0] = bit field mask
Notes: a bit is set for each master entry in the array. ie if this value equals 0x7 then it
means there is a master entry in the first three locations. So NMT_SUBBLOCK_ENTRY_1, NMT_SUBBLOCK_ENTRY_2
and NMT_SUBBLOCK_ENTRY_3 can be read.
At present only 32 masters are supported so only this first word is used
0x22FFC012 Reserved - - Reserved
0x22FFC013 Reserved - - Reserved
0x22FFC014 Reserved - - Reserved
0x22FFC015 Reserved - - Reserved
0x22FFC016 Reserved - - Reserved
0x22FFC017 Reserved - - Reserved
0x22FFC018 Reserved - - Reserved
0x22FFC019 Reserved - - Reserved
0x22FFC01A Reserved - - Reserved
0x22FFC01B Reserved - - Reserved
0x22FFC01C Reserved - - Reserved
0x22FFC01D Reserved - - Reserved
0x22FFC01E Reserved - - Reserved
0x22FFC01F Reserved - - Reserved
0x22FFC020 Reserved - - Reserved

Clock PLL 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x23000000 Source status params
0x23004000 Source config params
0x23008000 Source reference params
0x2300C000 UTC Offset
0x23010000 Holdover controller config
0x23014000 BinaryLockMonitor config
0x23018000 Frequency offset
0x23080000 Input configuration

Clock PLL 1 Configuration : Source status params

[Back to index | Back to parent block]
Address Name RW Default Description
0x23000000 Source state RO 0 Bits[31:3] reserved
Bits[2:0] Source state. Valid values:
0 void. Empty
1 invalid. No time is available.
2 valid. Time is available but the source has not been selected.
3 measuring. The source has been selected and is measuring freq or phase offset.
4 holdover. The source has lost lock and is currently in holdover.
5 running. The source is providing time information.
0x23000001 Source phase lag error RO - Bits[31:0] Phase lag error expressed as a single precision floating point number
0x23000002 Source measured noise RO - Bits[31:0] Measured noise expressed as a single precision floating point number
0x23000003 Source holdover validity RO - Bits[31:0] Holdover validity expressed as a single precision floating point number
0x23000004 Source lock value RO - Bits[31:0] Lock value expressed as a single precision floating point number
Range 0.0 to 1.0
0x23000005 Source locked state RO 0 Bits[31:1] Reserved
Bits[0] 0 - not locked, 1 - locked
0x23000006 Phase error gradient RO - Bits[31:0] Phase error gradient expressed as a single precision floating point number
This equals the frequency error of the Clock PLL with respect to its time source.
0x23000007 Source type RO - Bits[31:2] Reserved
Bits[1:0] 0 = Clock, 1 = Normal PTP, 2 = Hybrid PTP.
0x23000010 Clock PLL time secs bits 47 to 32 RO - Bits[31:16] = reserved
Bits[15:0] = Clock PLL time seconds bits 47 to 32 of 48 bit seconds field
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x23000011 Clock PLL time seconds bits 31 to 0 RO - Bits[31:0] = Clock PLL time seconds bits 31 to 0 of 48 bit seconds field
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x23000012 Clock PLL time nanoseconds RO - Bits[31:0] = Clock PLL time nanoseconds
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x23000013 Clock PLL time TAI flag RO - Bits[31:1] = reserved
Bits[0] = 1 is TAI flag is TRUE, 0 if FALSE
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x23000020 Current value of input source Clock Class RO - Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
Note that this may not be the same as 0x23008002 if the source is in holdover.

Clock PLL 1 Configuration : Source config params

[Back to index | Back to parent block]
Address Name RW Default Description
0x23004000 Clock PLL Unlocked Bandwidth RW - Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x23004001 Clock PLL Locked Bandwidth RW - Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x23004002 Frequency Measurement Duration RW 10 Bits[31:16] Reserved
Bits[15:0] Duration of the initial frequency measurement period in seconds
0x23004003 Frequency Measurement Minimum Samples RW 0 Bits[31:16] Reserved
Bits[15:0] The minimum number of samples to be used in the initial frequency measurement period.
0x23004004 Configured phase lag RW 0.0 Bits[31:0] Configured phase lag in seconds expressed as a single precision floating point number
0x23004009 Minimum lock value to be master RW 0.1 Bits[31:0] Lock value expressed as a single precision floating point number
The minimum lock value for an input source used as a time reference on a PTP port for the port to enter master state
0x23004023 Phase buildout property for node time 1 RW 0 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Note the default value is different for PTP source and Clock source.
0x23004024 Phase buildout property for node time 2 RW 0 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Note the default value is different for PTP source and Clock source.
0x23004040 Reserved - - Reserved
0x23004041 Reserved - - Reserved
0x23004042 Reserved - - Reserved
0x23004043 Reserved - - Reserved
0x23004044 Reserved - - Reserved
0x23004045 Reserved - - Reserved
0x23004052 Reserved - - Reserved

Clock PLL 1 Configuration : Source reference params

[Back to index | Back to parent block]
Address Name RW Default Description
0x23008000 Node ID bytes 0-3 RW 0 Bits[31:24] Node ID byte 0
Bits[23:16] Node ID byte 1
Bits[15:8] Node ID byte 2
Bits[7:0] Node ID byte 3
0x23008001 Node ID bytes 4-7 RW 0 Bits[31:24] Node ID byte 4
Bits[23:16] Node ID byte 5
Bits[15:8] Node ID byte 6
Bits[7:0] Node ID byte 7
0x23008002 Clock Class RW 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
0x23008003 Time Source RW 0 Bits[31:4] Reserved
Bits[3:0] Time source. Allowed values
000 Atomic clock
001 GPS
010 Terrestrial (radio)
011 PTP
100 NTP
101 Hand set
110 Other source
111 internalOscillator. No time reference at all
1000 smpte time source F0 (arb)
1001 smpte time source F1
0x23008004 Clock Accuracy RW 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock Accuracy. Allowed values:
0x20 NS25 The time is accurate to within 25 ns
0x21 NS100 The time is accurate to within 100 ns
0x22 NS250 The time is accurate to within 250 ns
0x23 US1 The time is accurate to within 1 us
0x24 US2_5 The time is accurate to within 2.5 us
0x25 US10 The time is accurate to within 10 us
0x26 US25 The time is accurate to within 25 us
0x27 US100 The time is accurate to within 100 us
0x28 US250 The time is accurate to within 250 us
0x29 MS1 The time is accurate to within 1 ms
0x2A MS2_5 The time is accurate to within 2.5 ms
0x2B MS10 The time is accurate to within 10 ms
0x2C MS25 The time is accurate to within 25 ms
0x2D MS100 The time is accurate to within 100 ms
0x2E MS250 The time is accurate to within 250 ms
0x2F S1 The time is accurate to within 1 s
0x30 S10 The time is accurate to within 10 s
0x31 GT10S The time is accurate to >10 s
0xFE ACC_UNKNOWN The time accuracy is unknown
0x23008005 Offset scaled log variance RW 0 Bits[31:16] Reserved
Bits[15:0] IEEE1588 Offset scaled log variance defined in 1588 v2 7.6.3.3
0x23008006 Time valid RW 0 Bits[31:1] Reserved
Bits[0] 1 - The time is a valid TAI time, 0 otherwise
0x23008007 Priority 1 value RW 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x23008008 Priority 2 value RW 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x23008009 Steps removed value RW 0 Bits[31:16] Reserved
Bits[15:0] Steps removed value
0x2300800A Local Priority value RW 0 Bits[31:8] Reserved
Bits[7:0] Local Priority value

Clock PLL 1 Configuration : UTC Offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x2300C000 UTC Offset Value RW 0 Bits[31:0] UTC Offset value as a signed integer. Valid range covers bits 15:0 only
0x2300C001 UTC Offset Value RW 0 Bits[31:1] Reserved
Bits[0] 1 UTC Offset value is valid, 0 UTC Offset value is invalid
0x2300C004 Days to leap second RW 0 Bits[31:0] Number of days as a signed integer. Valid range covers bits 15:0 only
If leap second will happen at the next midnight (UTC time) number of days = 0.
If leap second will happen at tomorrow's midnight (UTC time) number of days = 1.
Number of days must not be greater than MAX_WARNING_DAYS.
Setting this value to <0 will clear any pending leap second and reset the
"Leap second is positive" register (below) to zero.
0x2300C005 Leap second is positive RW 0 Bits[31:1] Reserved
Bits[0] 1 leap second jump is positive, 0 leap second jump is negative
Note this register can only be updated if "Days to leap second" register (above) is >= 0

Clock PLL 1 Configuration : Holdover controller config

[Back to index | Back to parent block]
Address Name RW Default Description
0x23010000 Duration value RW 0 Bits[31:0] Duration value as a unsigned integer.
0x23010001 Reset W0 0 Bits[31:1] = reserved
Bits[0] = any value.
Notes: This resets the holdover data used to maintain effective holdover in the absence
of an input source. It does not force the PLL to exit the holdover state and should not
be used when the PLL is in holdover
0x23010002 Disable/enable forceHoldover RW 0 Bits[31:1] = reserved
Bits[0] = 1 - ForceHoldover enabled, 0 - disabled
0x23010003 clock class on entering holdover RW 14 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value on entering holdover
0x23010004 clock class after holdover duration RW 193 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value after the holdover duration has expired

Clock PLL 1 Configuration : BinaryLockMonitor config

[Back to index | Back to parent block]
Address Name RW Default Description
0x23014000 Binary error acceptable RW 1.0e-6 Bits[31:0] value as a float value.
0x23014001 Binary error unacceptable RW 5.0e-6 Bits[31:0] value as a float value.
0x23014002 Binary error gradient acceptable RW 1.0e-9 Bits[31:0] value as a float value.
0x23014003 Binary error gradient unacceptable RW 2.5e-9 Bits[31:0] value as a float value.
0x23014004 Binary fuzzy lock acceptable RW 0.5 Bits[31:0] value as a float value.
0x23014005 Binary fuzzy lock unacceptable RW 0.25 Bits[31:0] value as a float value.
0x23014006 Binary force lock RW 0 Bits[31:2] reserved.
Bits[1:0] 2 = Forced to UnLocked State, 1 = Forced to Locked State, 0 = Not Forced
0x23014007 Binary maintain lock during source switch RW 0 Bits[31:1] reserved.
Bits[0] 1 = Maintain Lock, 0 = Not Maintain Lock
0x23014008 Reserved - - Reserved
0x23014009 Reserved - - Reserved

Clock PLL 1 Configuration : Frequency offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x23018000 Clock PLL max frequency offset RW 0 Bits[31:0] Max frequency offset in Hz expressed as a single precision floating point number
Value in Hz
0x23018001 Clock PLL current frequency offset RO 0 Bits[31:0] = Current frequency offset in Hz expressed as a single precision floating point number
This register is provided for oscillator calibration.

Clock PLL 1 Configuration : Input configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x23080000 Bitmask to enable clock inputs RW 0x1 Bits[31:8] = Reserved
Bits[7:0] = A bit mask where '1' indicates enabled, and '0' indicates disabled. Bits 0-3 are mux inputs 0-3 respectively and bits 4-7 are ipclk inputs 4-7 respectively.
Notes: A source can only be enabled if it's frequency is non-zero.
0x23080001 Select an input clock RW 0x1 Bits[31:0] = Value selecting the input clock source. 0-3 selects mux inputs 0-3 respectively and 4-7 selects ipclk inputs 4-7 respectively.
0 - MUX input 0 is selected
1 - MUX input 1 is selected
2 - MUX input 2 is selected
3 - MUX input 3 is selected
4 - IPCLK input 4 is selected
5 - IPCLK input 5 is selected
6 - IPCLK input 6 is selected
7 - IPCLK input 7 is selected
Notes: A source can only be selected if it's frequency is non-zero and it is enabled.
0x23080002 Used to set the seconds of the most recent clock edge RW 0 Bits[31:16] = Must be set to zero
Bits[15:0] = The most significant 2 bytes of the seconds count of the most recent clock edge with the most significant byte in bits[15:8]. The register contents do not take effect until register 0x23080005 is written to and are ignored unless the selected input frequency is 1Hz.
0x23080003 Used to set the seconds of the most recent clock edge RW 0 Bits[31:0] = The least significant 4 bytes of the seconds count of the most recent clock edge with the least significant byte in bits[7:0]. The register contents do not take effect until register 0x23080005 is written to and are ignored unless the selected input frequency is 1Hz.
0x23080004 Used to set the nanoseconds of the most recent clock edge RW 0 Bits[31:0] = Nanoseconds portion of the time of most the recent clock edge. The register contents do not take effect until register 0x23080005 is written to and are ignored unless the selected input frequency is 1Hz.
0x23080005 Used to set the time of the most recent clock edge RW 0 The time scale used to interpret the time of the most recent edge. Writing to this register causes the contents of the seconds and nanoseconds registers to be read by ToPSync and applied as the time for the most recent clock edge, interpreted using the time scale (GPS or TAI) as written to this register. Ignored unless the selected input frequency is 1Hz.
Bits[31:0] = 0x0 => UTC,
0x1 => TAI,
0x2 => GPS
0x3 => ARB
0x23080008 TOD input message threshold RW 2 Bits[31:8] = reserved
Bits[7:0] = Threshold
ToPSync must receive a sequence of 'Threshold' TOD messages before it accepts the input as valid.
A value of zero means that a single message is accepted as valid.

Clock PLL 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x24000000 Source status params
0x24004000 Source config params
0x24008000 Source reference params
0x2400C000 UTC Offset
0x24010000 Holdover controller config
0x24014000 BinaryLockMonitor config
0x24018000 Frequency offset
0x24080000 Input configuration

Clock PLL 2 Configuration : Source status params

[Back to index | Back to parent block]
Address Name RW Default Description
0x24000000 Source state RO 0 Bits[31:3] reserved
Bits[2:0] Source state. Valid values:
0 void. Empty
1 invalid. No time is available.
2 valid. Time is available but the source has not been selected.
3 measuring. The source has been selected and is measuring freq or phase offset.
4 holdover. The source has lost lock and is currently in holdover.
5 running. The source is providing time information.
0x24000001 Source phase lag error RO - Bits[31:0] Phase lag error expressed as a single precision floating point number
0x24000002 Source measured noise RO - Bits[31:0] Measured noise expressed as a single precision floating point number
0x24000003 Source holdover validity RO - Bits[31:0] Holdover validity expressed as a single precision floating point number
0x24000004 Source lock value RO - Bits[31:0] Lock value expressed as a single precision floating point number
Range 0.0 to 1.0
0x24000005 Source locked state RO 0 Bits[31:1] Reserved
Bits[0] 0 - not locked, 1 - locked
0x24000006 Phase error gradient RO - Bits[31:0] Phase error gradient expressed as a single precision floating point number
This equals the frequency error of the Clock PLL with respect to its time source.
0x24000007 Source type RO - Bits[31:2] Reserved
Bits[1:0] 0 = Clock, 1 = Normal PTP, 2 = Hybrid PTP.
0x24000010 Clock PLL time secs bits 47 to 32 RO - Bits[31:16] = reserved
Bits[15:0] = Clock PLL time seconds bits 47 to 32 of 48 bit seconds field
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x24000011 Clock PLL time seconds bits 31 to 0 RO - Bits[31:0] = Clock PLL time seconds bits 31 to 0 of 48 bit seconds field
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x24000012 Clock PLL time nanoseconds RO - Bits[31:0] = Clock PLL time nanoseconds
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x24000013 Clock PLL time TAI flag RO - Bits[31:1] = reserved
Bits[0] = 1 is TAI flag is TRUE, 0 if FALSE
Notes: This parameter is consistent with the other Clock PLL time registers if read in the same api message
0x24000020 Current value of input source Clock Class RO - Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
Note that this may not be the same as 0x24008002 if the source is in holdover.

Clock PLL 2 Configuration : Source config params

[Back to index | Back to parent block]
Address Name RW Default Description
0x24004000 Clock PLL Unlocked Bandwidth RW - Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x24004001 Clock PLL Locked Bandwidth RW - Bits[31:0] Bandwidth in Hz expressed as a single precision floating point number
0x24004002 Frequency Measurement Duration RW 10 Bits[31:16] Reserved
Bits[15:0] Duration of the initial frequency measurement period in seconds
0x24004003 Frequency Measurement Minimum Samples RW 0 Bits[31:16] Reserved
Bits[15:0] The minimum number of samples to be used in the initial frequency measurement period.
0x24004004 Configured phase lag RW 0.0 Bits[31:0] Configured phase lag in seconds expressed as a single precision floating point number
0x24004009 Minimum lock value to be master RW 0.1 Bits[31:0] Lock value expressed as a single precision floating point number
The minimum lock value for an input source used as a time reference on a PTP port for the port to enter master state
0x24004023 Phase buildout property for node time 1 RW 0 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Note the default value is different for PTP source and Clock source.
0x24004024 Phase buildout property for node time 2 RW 0 Bits[31:2] Reserved
Bits[1:0] 0 = Is not aligned, 1 = Is frequency aligned, 2 = Is phase aligned
Note the default value is different for PTP source and Clock source.
0x24004040 Reserved - - Reserved
0x24004041 Reserved - - Reserved
0x24004042 Reserved - - Reserved
0x24004043 Reserved - - Reserved
0x24004044 Reserved - - Reserved
0x24004045 Reserved - - Reserved
0x24004052 Reserved - - Reserved

Clock PLL 2 Configuration : Source reference params

[Back to index | Back to parent block]
Address Name RW Default Description
0x24008000 Node ID bytes 0-3 RW 0 Bits[31:24] Node ID byte 0
Bits[23:16] Node ID byte 1
Bits[15:8] Node ID byte 2
Bits[7:0] Node ID byte 3
0x24008001 Node ID bytes 4-7 RW 0 Bits[31:24] Node ID byte 4
Bits[23:16] Node ID byte 5
Bits[15:8] Node ID byte 6
Bits[7:0] Node ID byte 7
0x24008002 Clock Class RW 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock class values
0x24008003 Time Source RW 0 Bits[31:4] Reserved
Bits[3:0] Time source. Allowed values
000 Atomic clock
001 GPS
010 Terrestrial (radio)
011 PTP
100 NTP
101 Hand set
110 Other source
111 internalOscillator. No time reference at all
1000 smpte time source F0 (arb)
1001 smpte time source F1
0x24008004 Clock Accuracy RW 0 Bits[31:8] Reserved
Bits[7:0] IEEE1588 Clock Accuracy. Allowed values:
0x20 NS25 The time is accurate to within 25 ns
0x21 NS100 The time is accurate to within 100 ns
0x22 NS250 The time is accurate to within 250 ns
0x23 US1 The time is accurate to within 1 us
0x24 US2_5 The time is accurate to within 2.5 us
0x25 US10 The time is accurate to within 10 us
0x26 US25 The time is accurate to within 25 us
0x27 US100 The time is accurate to within 100 us
0x28 US250 The time is accurate to within 250 us
0x29 MS1 The time is accurate to within 1 ms
0x2A MS2_5 The time is accurate to within 2.5 ms
0x2B MS10 The time is accurate to within 10 ms
0x2C MS25 The time is accurate to within 25 ms
0x2D MS100 The time is accurate to within 100 ms
0x2E MS250 The time is accurate to within 250 ms
0x2F S1 The time is accurate to within 1 s
0x30 S10 The time is accurate to within 10 s
0x31 GT10S The time is accurate to >10 s
0xFE ACC_UNKNOWN The time accuracy is unknown
0x24008005 Offset scaled log variance RW 0 Bits[31:16] Reserved
Bits[15:0] IEEE1588 Offset scaled log variance defined in 1588 v2 7.6.3.3
0x24008006 Time valid RW 0 Bits[31:1] Reserved
Bits[0] 1 - The time is a valid TAI time, 0 otherwise
0x24008007 Priority 1 value RW 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x24008008 Priority 2 value RW 0 Bits[31:8] Reserved
Bits[7:0] Priority 1 value
0x24008009 Steps removed value RW 0 Bits[31:16] Reserved
Bits[15:0] Steps removed value
0x2400800A Local Priority value RW 0 Bits[31:8] Reserved
Bits[7:0] Local Priority value

Clock PLL 2 Configuration : UTC Offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x2400C000 UTC Offset Value RW 0 Bits[31:0] UTC Offset value as a signed integer. Valid range covers bits 15:0 only
0x2400C001 UTC Offset Value RW 0 Bits[31:1] Reserved
Bits[0] 1 UTC Offset value is valid, 0 UTC Offset value is invalid
0x2400C004 Days to leap second RW 0 Bits[31:0] Number of days as a signed integer. Valid range covers bits 15:0 only
If leap second will happen at the next midnight (UTC time) number of days = 0.
If leap second will happen at tomorrow's midnight (UTC time) number of days = 1.
Number of days must not be greater than MAX_WARNING_DAYS.
Setting this value to <0 will clear any pending leap second and reset the
"Leap second is positive" register (below) to zero.
0x2400C005 Leap second is positive RW 0 Bits[31:1] Reserved
Bits[0] 1 leap second jump is positive, 0 leap second jump is negative
Note this register can only be updated if "Days to leap second" register (above) is >= 0

Clock PLL 2 Configuration : Holdover controller config

[Back to index | Back to parent block]
Address Name RW Default Description
0x24010000 Duration value RW 0 Bits[31:0] Duration value as a unsigned integer.
0x24010001 Reset W0 0 Bits[31:1] = reserved
Bits[0] = any value.
Notes: This resets the holdover data used to maintain effective holdover in the absence
of an input source. It does not force the PLL to exit the holdover state and should not
be used when the PLL is in holdover
0x24010002 Disable/enable forceHoldover RW 0 Bits[31:1] = reserved
Bits[0] = 1 - ForceHoldover enabled, 0 - disabled
0x24010003 clock class on entering holdover RW 14 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value on entering holdover
0x24010004 clock class after holdover duration RW 193 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value after the holdover duration has expired

Clock PLL 2 Configuration : BinaryLockMonitor config

[Back to index | Back to parent block]
Address Name RW Default Description
0x24014000 Binary error acceptable RW 1.0e-6 Bits[31:0] value as a float value.
0x24014001 Binary error unacceptable RW 5.0e-6 Bits[31:0] value as a float value.
0x24014002 Binary error gradient acceptable RW 1.0e-9 Bits[31:0] value as a float value.
0x24014003 Binary error gradient unacceptable RW 2.5e-9 Bits[31:0] value as a float value.
0x24014004 Binary fuzzy lock acceptable RW 0.5 Bits[31:0] value as a float value.
0x24014005 Binary fuzzy lock unacceptable RW 0.25 Bits[31:0] value as a float value.
0x24014006 Binary force lock RW 0 Bits[31:2] reserved.
Bits[1:0] 2 = Forced to UnLocked State, 1 = Forced to Locked State, 0 = Not Forced
0x24014007 Binary maintain lock during source switch RW 0 Bits[31:1] reserved.
Bits[0] 1 = Maintain Lock, 0 = Not Maintain Lock
0x24014008 Reserved - - Reserved
0x24014009 Reserved - - Reserved

Clock PLL 2 Configuration : Frequency offset

[Back to index | Back to parent block]
Address Name RW Default Description
0x24018000 Clock PLL max frequency offset RW 0 Bits[31:0] Max frequency offset in Hz expressed as a single precision floating point number
Value in Hz
0x24018001 Clock PLL current frequency offset RO 0 Bits[31:0] = Current frequency offset in Hz expressed as a single precision floating point number
This register is provided for oscillator calibration.

Clock PLL 2 Configuration : Input configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x24080000 Bitmask to enable clock inputs RW 0x1 Bits[31:8] = Reserved
Bits[7:0] = A bit mask where '1' indicates enabled, and '0' indicates disabled. Bits 0-3 are mux inputs 0-3 respectively and bits 4-7 are ipclk inputs 4-7 respectively.
Notes: A source can only be enabled if it's frequency is non-zero.
0x24080001 Select an input clock RW 0x1 Bits[31:0] = Value selecting the input clock source. 0-3 selects mux inputs 0-3 respectively and 4-7 selects ipclk inputs 4-7 respectively.
0 - MUX input 0 is selected
1 - MUX input 1 is selected
2 - MUX input 2 is selected
3 - MUX input 3 is selected
4 - IPCLK input 4 is selected
5 - IPCLK input 5 is selected
6 - IPCLK input 6 is selected
7 - IPCLK input 7 is selected
Notes: A source can only be selected if it's frequency is non-zero and it is enabled.
0x24080002 Used to set the seconds of the most recent clock edge RW 0 Bits[31:16] = Must be set to zero
Bits[15:0] = The most significant 2 bytes of the seconds count of the most recent clock edge with the most significant byte in bits[15:8]. The register contents do not take effect until register 0x24080005 is written to and are ignored unless the selected input frequency is 1Hz.
0x24080003 Used to set the seconds of the most recent clock edge RW 0 Bits[31:0] = The least significant 4 bytes of the seconds count of the most recent clock edge with the least significant byte in bits[7:0]. The register contents do not take effect until register 0x24080005 is written to and are ignored unless the selected input frequency is 1Hz.
0x24080004 Used to set the nanoseconds of the most recent clock edge RW 0 Bits[31:0] = Nanoseconds portion of the time of most the recent clock edge. The register contents do not take effect until register 0x24080005 is written to and are ignored unless the selected input frequency is 1Hz.
0x24080005 Used to set the time of the most recent clock edge RW 0 The time scale used to interpret the time of the most recent edge. Writing to this register causes the contents of the seconds and nanoseconds registers to be read by ToPSync and applied as the time for the most recent clock edge, interpreted using the time scale (GPS or TAI) as written to this register. Ignored unless the selected input frequency is 1Hz.
Bits[31:0] = 0x0 => UTC,
0x1 => TAI,
0x2 => GPS
0x3 => ARB
0x24080008 TOD input message threshold RW 2 Bits[31:8] = reserved
Bits[7:0] = Threshold
ToPSync must receive a sequence of 'Threshold' TOD messages before it accepts the input as valid.
A value of zero means that a single message is accepted as valid.

Node Time 1 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x27000000 Node Time Status (RO)
0x27004000 Node Time Config (RW)
0x27008000 Node Time Holdover Controller Config (RW)
0x2700C000 Node Time BinaryLockMonitor config

Node Time 1 Configuration : Node Time Status (RO)

[Back to index | Back to parent block]
Address Name RW Default Description
0x27000000 Source selected by node time as a bitmask RO 0 Bits[31:4] = Reserved
Bits[3:0] =
Permitted values:
1000 PTP PLL2 selected
0100 PTP PLL1 selected
0010 Clock PLL2 selected
0001 Clock PLL1 selected
0000 Local oscillator selected (no external source selected)
0x27000001 Node time secs bits 47 to 32 RO - Bits[31:16] = reserved
Bits[15:0] = node time seconds bits 47 to 32 of 48 bit seconds field
Notes: This parameter is consistent with the other node time registers if read in the same api message
0x27000002 Node time seconds bits 31 to 0 RO - Bits[31:0] = node time seconds bits 31 to 0 of 48 bit seconds field
Notes: This parameter is consistent with the other node time registers if read in the same api message
0x27000003 Node time nanoseconds RO - Bits[31:0] = node time nanoseconds
Notes: This parameter is consistent with the other node time registers if read in the same api message
0x27000004 Node time TAI flag RO - Bits[31:1] = reserved
Bits[0] = 1 is TAI flag is TRUE, 0 if FALSE
Notes: This parameter is consistent with the other node time registers if read in the same api message

Node Time 1 Configuration : Node Time Config (RW)

[Back to index | Back to parent block]
Address Name RW Default Description
0x27004000 Enable inputs for selection by node time RW 1111B or 0000B Bits[31:4] Reserved
Bits[3] = 1 - enable PTP PLL2 input for selection, 0 - disable PTP PLL2 input
Bits[2] = 1 - enable PTP PLL1 input for selection, 0 - disable PTP PLL1 input
Bits[1] = 1 - enable Clock PLL2 input for selection, 0 - disable Clock PLL2 input
Bits[0] = 1 - enable Clock PLL1 input for selection, 0 - disable Clock PLL1 input
Notes: the default value for nodeTime 1 is 1111B and for nodeTime 2 is 0000B.
0x27004001 Enable NON-revertive Operation RW 0 Bits[31:1] Reserved
Bits[0] = 1 - NON-revertive operation enabled, 0 - Revertive operation enable
0x27004002 Enable Phase Build Out RW 1 Bits[31:1] Reserved
Bits[0] = 1 - Phase build out enabled, 0 - disabled
0x27004003 The period to complete phasePullIn RW 900 Bits[31:0] float in unit of second
0x27004004 The maximum phase difference for phasePullIn otherwise do a phase jump RW 1.0e-3 Bits[31:0] float in unit of second
0x27004005 The maximum allowed phase change rate during phasePullIn RW 50e-9 Bits[31:0] float in unit of second per second
0x27004006 Enable NON-revertive Operation On Same Transport RW 0 Bits[31:1] Reserved
Bits[0] = 1 - NON-revertive operation enabled, 0 - Revertive operation enabled
Note this controls the revertive operation on the Node Time inputs. There is a separate configuration
for revertive operation within a PTP port
0x27004007 Configures the BMCA steps to be performed RW 0x1BE Bits[31:16] Reserved
Bits[15:0] = mask
0x01 GM Priority1
0x02 GM Identity
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values
0x100 GM LocalPriority
Notes: Configures which steps in the best master clock algorithm are performed.
The default value is 0x1BE, ie all steps enabled except for Steps Removed and Priority1
0x27004008 Highest clock class that can be a master RW 0xFE Bits[31:8] Reserved
Bits[7:0] = Clock class
Notes: If a master has a higher (therefore worse) clock class than this value then it cannot be selected
as a master.
0x27004009 Set Node Time Input manually RW 0xFF Bits[31:8] = Reserved
Bits[7:0] =
Permitted values:
(0) Clock PLL 1
(1) Clock PLL 2
(2) PTP PLL 1
(3) PTP PLL 2
(255) Node Time input selection is automatic (default)
Notes: Manually selected input must be enabled (see register 0x27004000)
0x27004010 Node time secs bits 47 to 32 RW - Bits[31:16] = reserved
Bits[15:0] = node time seconds bits 47 to 32 of 48 bit seconds field
Notes: When read this shows the last setting to configure the node time
To read the current node time see register 0x27000001
The time is not set until the register 0x27004012 is written
0x27004011 Node time secs bits 31 to 0 RW - Bits[31:0] = node time seconds bits 31 to 0 of 48 bit seconds field
Notes: When read this shows the last setting to configure the node time
To read the current node time see register 0x27000002
The time is not set until the register 0x27004012 is written
0x27004012 Node Time TAI and update the node time with the configured time RW - Bits[31:1] = Reserved
Bits[0] = Node Time is TAI
When written to this register updates the node time with the configured values
WARNING: THIS WILL HAVE UNSTABLE SIDE EFFECTS IF THE SYSTEM IS CURRENTLY LOCKED TO A TIME INPUT
0x27004013 Node Time UTC Offset value RW - Bits[31:0] UTC Offset value as a signed integer. Valid range covers bits 15:0 only
Notes: This is the configured value for the Node Time when running without an input source
When the node time has a valid input the UTC Offset is inherited from the input
0x27004014 Node Time UTC Offset valid RW - Bits[31:1] Reserved
Bits[0] 1 UTC Offset value is valid, 0 UTC Offset value is invalid
Notes: This is the configured value for the Node Time when running without an input source
When the node time has a valid input the UTC Offset is inherited from the input
0x27004018 Reserved - - Reserved
0x27004019 Configured phase lag RW 0.0 Bits[31:0] Configured phase lag in seconds expressed as a single precision floating point number
0x27004020 Reserved - - Reserved
0x27004021 Reserved - - Reserved

Node Time 1 Configuration : Node Time Holdover Controller Config (RW)

[Back to index | Back to parent block]
Address Name RW Default Description
0x27008000 Holdover duration RW 3600 Bits[31:0] Duration value as a unsigned integer.
0x27008001 Holdover reset WO 0 Bits[31:1] = reserved
Bits[0] = any value.
0x27008002 Force holdover RW 0 Bits[31:1] = reserved
Bits[0] = 1 - ForceHoldover enabled, 0 - disabled
0x27008003 clock class on entering holdover RW 14 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value on entering holdover
0x27008004 clock class after holdover duration RW 193 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value after the holdover duration has expired

Node Time 1 Configuration : Node Time BinaryLockMonitor config

[Back to index | Back to parent block]
Address Name RW Default Description
0x2700C000 Binary error acceptable RW 1.0e-6 Bits[31:0] value as a float value.
0x2700C001 Binary error unacceptable RW 5.0e-6 Bits[31:0] value as a float value.
0x2700C002 Binary error gradient acceptable RW 1.0e-9 Bits[31:0] value as a float value.
0x2700C003 Binary error gradient unaccpetable RW 2.5e-9 Bits[31:0] value as a unsigned integer.
0x2700C004 Binary fuzzy lock acceptable RW 0.5 Bits[31:0] value as a float value.
0x2700C005 Binary fuzzy lock unacceptable RW 0.25 Bits[31:0] value as a float value.
0x2700C006 Binary force lock RW 0 Bits[31:2] reserved.
Bits[1:0] 2 = Forced to UnLocked State, 1 = Forced to Locked State, 0 = Not Forced
0x2700C007 Binary maintain lock during source switch RW 0 Bits[31:1] reserved.
Bits[0] 1 = Maintain Lock, 0 = Not Maintain Lock

Node Time 2 Configuration : Sub Blocks

[Back to index]
Start Address Description
0x28000000 Node Time Status (RO)
0x28004000 Node Time Config (RW)
0x28008000 Node Time Holdover Controller Config (RW)
0x2800C000 Node Time BinaryLockMonitor config

Node Time 2 Configuration : Node Time Status (RO)

[Back to index | Back to parent block]
Address Name RW Default Description
0x28000000 Source selected by node time as a bitmask RO 0 Bits[31:4] = Reserved
Bits[3:0] =
Permitted values:
1000 PTP PLL2 selected
0100 PTP PLL1 selected
0010 Clock PLL2 selected
0001 Clock PLL1 selected
0000 Local oscillator selected (no external source selected)
0x28000001 Node time secs bits 47 to 32 RO - Bits[31:16] = reserved
Bits[15:0] = node time seconds bits 47 to 32 of 48 bit seconds field
Notes: This parameter is consistent with the other node time registers if read in the same api message
0x28000002 Node time seconds bits 31 to 0 RO - Bits[31:0] = node time seconds bits 31 to 0 of 48 bit seconds field
Notes: This parameter is consistent with the other node time registers if read in the same api message
0x28000003 Node time nanoseconds RO - Bits[31:0] = node time nanoseconds
Notes: This parameter is consistent with the other node time registers if read in the same api message
0x28000004 Node time TAI flag RO - Bits[31:1] = reserved
Bits[0] = 1 is TAI flag is TRUE, 0 if FALSE
Notes: This parameter is consistent with the other node time registers if read in the same api message

Node Time 2 Configuration : Node Time Config (RW)

[Back to index | Back to parent block]
Address Name RW Default Description
0x28004000 Enable inputs for selection by node time RW 1111B or 0000B Bits[31:4] Reserved
Bits[3] = 1 - enable PTP PLL2 input for selection, 0 - disable PTP PLL2 input
Bits[2] = 1 - enable PTP PLL1 input for selection, 0 - disable PTP PLL1 input
Bits[1] = 1 - enable Clock PLL2 input for selection, 0 - disable Clock PLL2 input
Bits[0] = 1 - enable Clock PLL1 input for selection, 0 - disable Clock PLL1 input
Notes: the default value for nodeTime 1 is 1111B and for nodeTime 2 is 0000B.
0x28004001 Enable NON-revertive Operation RW 0 Bits[31:1] Reserved
Bits[0] = 1 - NON-revertive operation enabled, 0 - Revertive operation enable
0x28004002 Enable Phase Build Out RW 1 Bits[31:1] Reserved
Bits[0] = 1 - Phase build out enabled, 0 - disabled
0x28004003 The period to complete phasePullIn RW 900 Bits[31:0] float in unit of second
0x28004004 The maximum phase difference for phasePullIn otherwise do a phase jump RW 1.0e-3 Bits[31:0] float in unit of second
0x28004005 The maximum allowed phase change rate during phasePullIn RW 50e-9 Bits[31:0] float in unit of second per second
0x28004006 Enable NON-revertive Operation On Same Transport RW 0 Bits[31:1] Reserved
Bits[0] = 1 - NON-revertive operation enabled, 0 - Revertive operation enabled
Note this controls the revertive operation on the Node Time inputs. There is a separate configuration
for revertive operation within a PTP port
0x28004007 Configures the BMCA steps to be performed RW 0x1BE Bits[31:16] Reserved
Bits[15:0] = mask
0x01 GM Priority1
0x02 GM Identity
0x04 GM Clock Class
0x08 GM Accuracy
0x10 GM offsetScaledLogVariance
0x20 GM Priority2
0x40 Steps Removed
0x80 GM Identity values
0x100 GM LocalPriority
Notes: Configures which steps in the best master clock algorithm are performed.
The default value is 0x1BE, ie all steps enabled except for Steps Removed and Priority1
0x28004008 Highest clock class that can be a master RW 0xFE Bits[31:8] Reserved
Bits[7:0] = Clock class
Notes: If a master has a higher (therefore worse) clock class than this value then it cannot be selected
as a master.
0x28004009 Set Node Time Input manually RW 0xFF Bits[31:8] = Reserved
Bits[7:0] =
Permitted values:
(0) Clock PLL 1
(1) Clock PLL 2
(2) PTP PLL 1
(3) PTP PLL 2
(255) Node Time input selection is automatic (default)
Notes: Manually selected input must be enabled (see register 0x28004000)
0x28004010 Node time secs bits 47 to 32 RW - Bits[31:16] = reserved
Bits[15:0] = node time seconds bits 47 to 32 of 48 bit seconds field
Notes: When read this shows the last setting to configure the node time
To read the current node time see register 0x28000001
The time is not set until the register 0x28004012 is written
0x28004011 Node time secs bits 31 to 0 RW - Bits[31:0] = node time seconds bits 31 to 0 of 48 bit seconds field
Notes: When read this shows the last setting to configure the node time
To read the current node time see register 0x28000002
The time is not set until the register 0x28004012 is written
0x28004012 Node Time TAI and update the node time with the configured time RW - Bits[31:1] = Reserved
Bits[0] = Node Time is TAI
When written to this register updates the node time with the configured values
WARNING: THIS WILL HAVE UNSTABLE SIDE EFFECTS IF THE SYSTEM IS CURRENTLY LOCKED TO A TIME INPUT
0x28004013 Node Time UTC Offset value RW - Bits[31:0] UTC Offset value as a signed integer. Valid range covers bits 15:0 only
Notes: This is the configured value for the Node Time when running without an input source
When the node time has a valid input the UTC Offset is inherited from the input
0x28004014 Node Time UTC Offset valid RW - Bits[31:1] Reserved
Bits[0] 1 UTC Offset value is valid, 0 UTC Offset value is invalid
Notes: This is the configured value for the Node Time when running without an input source
When the node time has a valid input the UTC Offset is inherited from the input
0x28004018 Reserved - - Reserved
0x28004019 Configured phase lag RW 0.0 Bits[31:0] Configured phase lag in seconds expressed as a single precision floating point number
0x28004020 Reserved - - Reserved
0x28004021 Reserved - - Reserved

Node Time 2 Configuration : Node Time Holdover Controller Config (RW)

[Back to index | Back to parent block]
Address Name RW Default Description
0x28008000 Holdover duration RW 3600 Bits[31:0] Duration value as a unsigned integer.
0x28008001 Holdover reset WO 0 Bits[31:1] = reserved
Bits[0] = any value.
0x28008002 Force holdover RW 0 Bits[31:1] = reserved
Bits[0] = 1 - ForceHoldover enabled, 0 - disabled
0x28008003 clock class on entering holdover RW 14 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value on entering holdover
0x28008004 clock class after holdover duration RW 193 Bits[31:8] = reserved
Bits[7:0] = Clock class from Clock Class from IEEE1588 Clock stratum values
Notes: This is the holdover clock class value after the holdover duration has expired

Node Time 2 Configuration : Node Time BinaryLockMonitor config

[Back to index | Back to parent block]
Address Name RW Default Description
0x2800C000 Binary error acceptable RW 1.0e-6 Bits[31:0] value as a float value.
0x2800C001 Binary error unacceptable RW 5.0e-6 Bits[31:0] value as a float value.
0x2800C002 Binary error gradient acceptable RW 1.0e-9 Bits[31:0] value as a float value.
0x2800C003 Binary error gradient unaccpetable RW 2.5e-9 Bits[31:0] value as a unsigned integer.
0x2800C004 Binary fuzzy lock acceptable RW 0.5 Bits[31:0] value as a float value.
0x2800C005 Binary fuzzy lock unacceptable RW 0.25 Bits[31:0] value as a float value.
0x2800C006 Binary force lock RW 0 Bits[31:2] reserved.
Bits[1:0] 2 = Forced to UnLocked State, 1 = Forced to Locked State, 0 = Not Forced
0x2800C007 Binary maintain lock during source switch RW 0 Bits[31:1] reserved.
Bits[0] 1 = Maintain Lock, 0 = Not Maintain Lock

TDM (eSETS) Configuration : Sub Blocks

[Back to index]
Start Address Description
0x29000000 TDM Register Interface
0x29004000 MUXes for SETS inputs pins SETSI3, SETSI4

TDM (eSETS) Configuration : TDM Register Interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x29000000 TDM (eSETS) Register 0x0 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000001 TDM (eSETS) Register 0x1 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000002 TDM (eSETS) Register 0x2 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000003 TDM (eSETS) Register 0x3 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000004 TDM (eSETS) Register 0x4 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000005 TDM (eSETS) Register 0x5 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000006 TDM (eSETS) Register 0x6 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000007 TDM (eSETS) Register 0x7 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000008 TDM (eSETS) Register 0x8 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000009 TDM (eSETS) Register 0x9 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900000A TDM (eSETS) Register 0xA RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900000B TDM (eSETS) Register 0xB RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900000C TDM (eSETS) Register 0xC RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900000D TDM (eSETS) Register 0xD RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900000E TDM (eSETS) Register 0xE RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900000F TDM (eSETS) Register 0xF RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000010 TDM (eSETS) Register 0x10 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000011 TDM (eSETS) Register 0x11 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000012 TDM (eSETS) Register 0x12 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000013 TDM (eSETS) Register 0x13 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000014 TDM (eSETS) Register 0x14 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000015 TDM (eSETS) Register 0x15 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000016 TDM (eSETS) Register 0x16 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000017 TDM (eSETS) Register 0x17 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000018 TDM (eSETS) Register 0x18 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000019 TDM (eSETS) Register 0x19 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900001A TDM (eSETS) Register 0x1A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900001B TDM (eSETS) Register 0x1B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900001C TDM (eSETS) Register 0x1C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900001D TDM (eSETS) Register 0x1D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900001E TDM (eSETS) Register 0x1E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900001F TDM (eSETS) Register 0x1F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000020 TDM (eSETS) Register 0x20 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000021 TDM (eSETS) Register 0x21 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000022 TDM (eSETS) Register 0x22 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000023 TDM (eSETS) Register 0x23 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000024 TDM (eSETS) Register 0x24 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000025 TDM (eSETS) Register 0x25 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000026 TDM (eSETS) Register 0x26 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000027 TDM (eSETS) Register 0x27 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000028 TDM (eSETS) Register 0x28 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000029 TDM (eSETS) Register 0x29 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900002A TDM (eSETS) Register 0x2A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900002B TDM (eSETS) Register 0x2B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900002C TDM (eSETS) Register 0x2C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900002D TDM (eSETS) Register 0x2D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900002E TDM (eSETS) Register 0x2E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900002F TDM (eSETS) Register 0x2F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000030 TDM (eSETS) Register 0x30 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000031 TDM (eSETS) Register 0x31 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000032 TDM (eSETS) Register 0x32 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000033 TDM (eSETS) Register 0x33 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000034 TDM (eSETS) Register 0x34 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000035 TDM (eSETS) Register 0x35 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000036 TDM (eSETS) Register 0x36 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000037 TDM (eSETS) Register 0x37 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000038 TDM (eSETS) Register 0x38 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000039 TDM (eSETS) Register 0x39 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900003A TDM (eSETS) Register 0x3A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900003B TDM (eSETS) Register 0x3B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900003C TDM (eSETS) Register 0x3C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900003D TDM (eSETS) Register 0x3D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900003E TDM (eSETS) Register 0x3E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900003F TDM (eSETS) Register 0x3F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000040 TDM (eSETS) Register 0x40 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000041 TDM (eSETS) Register 0x41 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000042 TDM (eSETS) Register 0x42 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000043 TDM (eSETS) Register 0x43 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000044 TDM (eSETS) Register 0x44 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000045 TDM (eSETS) Register 0x45 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000046 TDM (eSETS) Register 0x46 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000047 TDM (eSETS) Register 0x47 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000048 TDM (eSETS) Register 0x48 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000049 TDM (eSETS) Register 0x49 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900004A TDM (eSETS) Register 0x4A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900004B TDM (eSETS) Register 0x4B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900004C TDM (eSETS) Register 0x4C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900004D TDM (eSETS) Register 0x4D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900004E TDM (eSETS) Register 0x4E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900004F TDM (eSETS) Register 0x4F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000050 TDM (eSETS) Register 0x50 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000051 TDM (eSETS) Register 0x51 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000052 TDM (eSETS) Register 0x52 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000053 TDM (eSETS) Register 0x53 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000054 TDM (eSETS) Register 0x54 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000055 TDM (eSETS) Register 0x55 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000056 TDM (eSETS) Register 0x56 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000057 TDM (eSETS) Register 0x57 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000058 TDM (eSETS) Register 0x58 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000059 TDM (eSETS) Register 0x59 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900005A TDM (eSETS) Register 0x5A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900005B TDM (eSETS) Register 0x5B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900005C TDM (eSETS) Register 0x5C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900005D TDM (eSETS) Register 0x5D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900005E TDM (eSETS) Register 0x5E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900005F TDM (eSETS) Register 0x5F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000060 TDM (eSETS) Register 0x60 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000061 TDM (eSETS) Register 0x61 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000062 TDM (eSETS) Register 0x62 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000063 TDM (eSETS) Register 0x63 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000064 TDM (eSETS) Register 0x64 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000065 TDM (eSETS) Register 0x65 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000066 TDM (eSETS) Register 0x66 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000067 TDM (eSETS) Register 0x67 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000068 TDM (eSETS) Register 0x68 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000069 TDM (eSETS) Register 0x69 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900006A TDM (eSETS) Register 0x6A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900006B TDM (eSETS) Register 0x6B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900006C TDM (eSETS) Register 0x6C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900006D TDM (eSETS) Register 0x6D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900006E TDM (eSETS) Register 0x6E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900006F TDM (eSETS) Register 0x6F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000070 TDM (eSETS) Register 0x70 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000071 TDM (eSETS) Register 0x71 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000072 TDM (eSETS) Register 0x72 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000073 TDM (eSETS) Register 0x73 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000074 TDM (eSETS) Register 0x74 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000075 TDM (eSETS) Register 0x75 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000076 TDM (eSETS) Register 0x76 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000077 TDM (eSETS) Register 0x77 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000078 TDM (eSETS) Register 0x78 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x29000079 TDM (eSETS) Register 0x79 RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900007A TDM (eSETS) Register 0x7A RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900007B TDM (eSETS) Register 0x7B RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900007C TDM (eSETS) Register 0x7C RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900007D TDM (eSETS) Register 0x7D RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900007E TDM (eSETS) Register 0x7E RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet
0x2900007F TDM (eSETS) Register 0x7F RW 0x0 Bits[31:8] = Reserved
Bits[7:0] = TDM (eSETS) Register. Refer to ACS9522 datasheet

TDM (eSETS) Configuration : MUXes for SETS inputs pins SETSI3, SETSI4

[Back to index | Back to parent block]
Address Name RW Default Description
0x29004000 TDM (eSETS) input SETSI3 MUX RW 0x0 TDM (eSETS) input SETSI3 is taken from either IpClk0 or the output of one of the PTP block's PhaseOPCLk's
Bits[31:1] Reserved
Bits[0:0]
0 - SETSI3 is driven from package pin IpClk0
1 - SETSI3 is driven by the clock that is driving OpClk0 (see 0x03010020 and 0x03010000)
0x29004001 TDM (eSETS) input SETSI4 MUX RW 0x0 TDM (eSETS) input SETSI4 is taken from either IpClk1 or the output of one of the PTP block's PhaseOPCLk's
0 - SETSI4 is driven from package pin IpClk1
1 - SETSI4 is driven by the clock that is driving OpClk1 (see 0x03010021 and 0x03010001)
0x29004002 Reserved - - Reserved
0x29004003 Reserved - - Reserved

Alarm Configuration : Sub Blocks

[Back to index]
Start Address Description
0x2A000000 Alarm In Holdover
0x2A004000 Alarm No Current Master
0x2A008000 Alarm No Clock Input
0x2A00C000 Alarm No Time Of Day Input
0x2A010000 Alarm Time Not TAI
0x2A014000 Alarm PTP Port Not Operational
0x2A018000 Alarm Visible Master Refused Sync Grant request
0x2A01C000 Alarm Visible Master Ignored Sync Grant Request
0x2A020000 Alarm Visible Master Refused Delay Response Grant request
0x2A024000 Alarm Visible Master Ignored Delay Response Grant request
0x2A028000 Alarm Visible Master Too Few Sync Messages
0x2A02C000 Alarm Visible Master Too Few Follow Up messages
0x2A030000 Alarm Visible Master Too Few delay Response messages
0x2A034000 Alarm Acc Master Refused Announce Grant Request
0x2A038000 Alarm Acc Master Ignored Announce Grant Request
0x2A03C000 Alarm Acc Master Too Few Announce Messages
0x2A040000 Alarm Current Master Too Many Syncs Without Follow Up
0x2A044000 Alarm Current Master Too Many Follow Ups without Sync
0x2A048000 Alarm Current Master Too Many Missing Delay Response Messages
0x2A04C000 Alarm M2S Packet Delay Variation
0x2A050000 Alarm S2M Packet Delay Variation
0x2A054000 Alarm UTC Offset Unknown
0x2A058000 Alarm TDM Interrupt
0x2A05C000 Alarm Path Delay Invalid
0x2A060000 Alarm Path Delay Too Few Responses
0x2A064000 Alarm Path Delay Too Many Unexpected Responses
0x2A068000 Alarm Path Delay Too Few Follow Ups
0x2A06C000 Alarm Path Delay Too Many Unexpected Follow Ups
0x2A070000 Alarm Leap Second Warning
0x2A074000 Alarm M2S Packet Delay Jump
0x2A078000 Alarm S2M Packet Delay Jump
0x2A07C000 Alarm Lock Detect (used in setting lock pin)
0x2A080000 Alarm Loss of lock (can be used in setting alarm pin)
0x2A084000 Alarm ECC Error
0x2A088000 Alarm User Data Ready
0x2A08C000 Alarm too few SM TLVs have been received
0x2A090000 Alarm new changed SM TLV data has been received
0x2A094000 Alarm loss announce
0x2A098000 Alarm loss sync
0x2AFFC000 Alarm system configuration

Alarm Configuration : Alarm In Holdover

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A000000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A000001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A000008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A000009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A000010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A000011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm No Current Master

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A004000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A004001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A004008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A004009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A004010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A004011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm No Clock Input

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A008000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A008001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A008008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A008009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A008010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A008011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm No Time Of Day Input

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A00C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A00C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A00C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A00C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A00C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A00C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Time Not TAI

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A010000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A010001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A010008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A010009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A010010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A010011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm PTP Port Not Operational

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A014000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A014001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A014008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A014009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A014010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A014011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Refused Sync Grant request

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A018000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A018001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A018008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A018009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A018010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A018011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Ignored Sync Grant Request

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A01C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A01C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A01C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A01C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A01C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A01C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Refused Delay Response Grant request

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A020000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A020001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A020008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A020009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A020010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A020011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Ignored Delay Response Grant request

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A024000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A024001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A024008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A024009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A024010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A024011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Too Few Sync Messages

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A028000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A028001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A028008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A028009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A028010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A028011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Too Few Follow Up messages

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A02C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A02C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A02C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A02C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A02C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A02C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Visible Master Too Few delay Response messages

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A030000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A030001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A030008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A030009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A030010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A030011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Acc Master Refused Announce Grant Request

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A034000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A034001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A034008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A034009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A034010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A034011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Acc Master Ignored Announce Grant Request

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A038000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A038001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A038008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A038009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A038010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A038011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Acc Master Too Few Announce Messages

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A03C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A03C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A03C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A03C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A03C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A03C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Current Master Too Many Syncs Without Follow Up

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A040000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A040001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A040008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A040009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A040010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A040011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Current Master Too Many Follow Ups without Sync

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A044000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A044001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A044008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A044009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A044010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A044011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Current Master Too Many Missing Delay Response Messages

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A048000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A048001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A048008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A048009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A048010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A048011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm M2S Packet Delay Variation

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A04C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A04C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A04C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A04C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A04C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A04C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm S2M Packet Delay Variation

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A050000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A050001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A050008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A050009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A050010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A050011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm UTC Offset Unknown

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A054000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A054001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A054008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A054009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A054010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A054011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm TDM Interrupt

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A058000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A058001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A058008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A058009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A058010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A058011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Path Delay Invalid

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A05C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A05C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A05C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A05C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A05C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A05C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Path Delay Too Few Responses

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A060000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A060001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A060008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A060009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A060010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A060011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Path Delay Too Many Unexpected Responses

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A064000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A064001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A064008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A064009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A064010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A064011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Path Delay Too Few Follow Ups

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A068000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A068001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A068008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A068009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A068010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A068011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Path Delay Too Many Unexpected Follow Ups

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A06C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A06C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A06C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A06C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A06C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A06C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Leap Second Warning

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A070000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A070001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A070008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A070009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A070010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A070011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm M2S Packet Delay Jump

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A074000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A074001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A074008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A074009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A074010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A074011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm S2M Packet Delay Jump

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A078000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A078001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A078008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A078009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A078010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A078011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Lock Detect (used in setting lock pin)

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A07C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A07C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A07C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A07C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A07C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A07C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm Loss of lock (can be used in setting alarm pin)

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A080000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A080001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A080008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A080009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A080010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A080011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm ECC Error

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A084000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A084001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A084008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A084009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A084010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A084011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm User Data Ready

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A088000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A088001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A088008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A088009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A088010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A088011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm too few SM TLVs have been received

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A08C000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A08C001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A08C008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A08C009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A08C010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A08C011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm new changed SM TLV data has been received

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A090000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A090001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A090008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A090009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A090010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A090011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm loss announce

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A094000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A094001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A094008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A094009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A094010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A094011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm loss sync

[Back to index | Back to parent block]
Address Name RW Default Description
0x2A098000 enable bits for client ids 1 to 32 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id, eg a value of 0x3 means that client 1 and 2 are enabled. Currently there can be
up to 64 clients for an alarm. This number may increase.
Note each of these sub blocks represents one alarm.
Note how the memory map addresses change for each alarm up to the last alarm.
If say an alarm has been raised by a client and that client id is masked in then a call to retrieve the parameter
'any alarms have been set' will have a value of 1.
0x2A098001 enable bits for client ids 33 to 64 RW 0 Bits[31:0] = 32 bit mask
Notes: Each bit represents a client id. eg a value of 0x3 means that client 33 and 34 are enabled
0x2A098008 alarm status bitfield for client id 1 to 32 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 2 has raised the alarm
0x2A098009 alarm status bitfield for client id 33 to 64 R0 0 Bits[31:0] = 32 bit bitfield
Notes: Each bit represents a client id, eg a value of 0x2 means that client 34 has raised the alarm
0x2A098010 request bitfield for client id 1 to 32 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.
0x2A098011 request bitfield for client id 33 to 64 RW 0 Bits[31:0] = 32 bit bitfield
Each bit represents an enabled client id that has raised an alarm.
In sticky or edge detect mode, after reading this, setting the required bit to 1 will clear the bit and allow another existing alarm to be propagated
and used in activating an alarm.

Alarm Configuration : Alarm system configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x2AFFC000 any alarms have been set RO 0 Bits[31:1] = reserved
Bits[0:0] 0 = no masked alarms have been set
1 = at least one masked alarm has been set
In normal mode this will be active if any of the enabled clients have activated their alarm
In sticky mode this will be active if any of the enabled clients have activated their alarm and will remain active until the
user has cleared the appropriate bit in alarm request bitfield.
In change detect mode this will be active if any of the enabled clients have activated or deactivated their alarm and will remain active until the
user has cleared the appropriate bit in alarm request bitfield.
Notes: Currently there can be up to 64 clients that can set each alarm source. Clients can be enabled for each alarm.
If at least one client has raised an alarm and this client is enabled in for that alarm (ie the bit representing it in
client mask x is '1') then this parameter will have a value of 1.
0x2AFFC001 active alarms bitfield showing which alarms are active RO 0 Bits[31:0] bitfield
Each bit represents an alarm, ie if bit 1 is 1 then the alarm inHoldover is active on a client etc
0x2AFFC002 active alarms bitfield showing which alarms are active RO 0 Bits[31:1] reserved
Bits[1:0] Each bit represents an alarm, ie if the first bit is 1 then the alarm value 32 (binary lock low used in alarm pin)
is active. If the second bit is 1 then the alarm value 33 Alarm ECC Error is active
0x2AFFC010 the alarm system mode of operation RW 0 Bits[31:2] = reserved
Bits[1:0] 0 = level mode
1 = sticky mode
2 = change detect mode
Level mode is when one of the enabled clients sets an alarm to active
Sticky mode is when one of the enabled clients sets an alarm active after being inactive. Check alarm request bitfield to see which client
activated the alarm. These bits will remain as '1' until cleared by the user.
Change detect mode is the same as Transitory mode except alarms can be triggered from going from active to inactive.

Network Configuration : Sub Blocks

[Back to index]
Start Address Description
0x2B000000 Network Parameters for ARP
0x2B004000 Parameters for ICMP Configuration

Network Configuration : Network Parameters for ARP

[Back to index | Back to parent block]
Address Name RW Default Description
0x2B000000 flush the arp table RW 0 Bits[31:1] = Reserved
Bits[0:0] = Flush the arp table. Valid values:
1 - Flush IPv4 entries

Network Configuration : Parameters for ICMP Configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x2B004000 enable echo ping RW 1 Note that the stack needs to have been compiled with echo ping config enabled for this enable/disable setting to have an effect.
Bits[31:1] = Reserved
Bits[0:0] = 0 - disable echo ping
1 - enable echo ping

NTP Configuration: Sub Blocks

[Back to index]
Start Address Description
0x2C000000 NTP configer

NTP Configuration: NTP configer

[Back to index | Back to parent block]
Address Name RW Default Description
0x2C000000 enable or disable NTP function W 0x0 Bits[31:1] = Reserved
Bits[0:0] = 0 - disable ntp server [default]
1 - enable ntp server
0x2C000001 enable or disable send ntp broadcast packet W 0x0 Bits[31:1] = Reserved
Bits[1:0] = 0 - disable ntp broadcast packet send [default]
1 - enable ntp bradcast packet
0x2C000002 enable or disable send ntp multicast packet W 0x0 Bits[31:1] = Reserved
Bits[1:0] = 0 - disable ntp multicast packet send [default]
1 - enable ntp multicast packet
0x2C000003 change ntp mulitcast address W 0x0 Bits[31:0] = IPV4 multicast address
0x2C000004 change ntp ipv6 multicast address W 0x0 Bits[31:0]
Bits[31:0]
Bits[31:0]
Bits[31:0] = IPV6 multicast address
0x2C00000A set configer the poll time for sending W 0x0 Bits[31:4] = Reserved
Bits[3:0] = [4-11] poll time should between 4 to 11.
0x2C00000B enable or disable ntp md5 auth W 0x0 Bits[31:1] = Reserved
Bits[1:0] = 0 - disable ntp md5 auth [default]
1 - enable ntp md5 auth
0x2C00000C select ntp to use network interface 0 or 1 W 0x0 Bits[31:1] = Reserved
Bits[1:0] = 0 - use network interface 0 [default]
1 - use network interface 1
0x2C00000D set ntp use ipv6 W 0x0 Bits[31:1] = Reserved
Bits[1:0] = 0 - ntp use ipv4 [default]
1 - ntp use ipv6
0x2C00000E set ntp md5 auth key W 0x0 Bits[31:0]
Bits[31:0]
Bits[31:0]
Bits[31:0]
Bits[31:0] = 20 bytes md5 auth key
0x2C000013 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 1) : Sub Blocks

[Back to index]
Start Address Description
0x32000000 Network Interface Parameters for network interface
0x3200C000 Network Interface Parameters for VLAN
0x32018000 Network Interface Parameters for IP4
0x3201C000 Network Interface Parameters for IP4 Statistics
0x32020000 Network Interface Parameters for IP4 status
0x32040000 Network Interface Parameters for ARP entry configuration
0x32044000 Network Interface Parameters for ARP table
0x32080000 Network Interface Parameters for IP6 address configuration
0x32084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x32000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3200C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3200C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3200C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3200C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x32018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x32018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x32018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x32018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x32018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x32018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x32018010 Reserved - - Reserved
0x32018011 Reserved - - Reserved
0x32018012 Reserved - - Reserved
0x32018020 Reserved - - Reserved
0x32018021 Reserved - - Reserved
0x32018022 Reserved - - Reserved
0x32018030 Reserved - - Reserved
0x32018031 Reserved - - Reserved
0x32018032 Reserved - - Reserved
0x32018040 Reserved - - Reserved
0x32018041 Reserved - - Reserved
0x32018042 Reserved - - Reserved
0x32018050 Reserved - - Reserved
0x32018051 Reserved - - Reserved
0x32018052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3201C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3201C001 Reserved - - Reserved
0x3201C002 Reserved - - Reserved
0x3201C003 Reserved - - Reserved
0x3201C004 Reserved - - Reserved
0x3201C005 Reserved - - Reserved
0x3201C006 Reserved - - Reserved
0x3201C007 Reserved - - Reserved
0x3201C008 Reserved - - Reserved
0x3201C009 Reserved - - Reserved
0x3201C00A Reserved - - Reserved
0x3201C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3201C00C Reserved - - Reserved
0x3201C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3201C00E Reserved - - Reserved
0x3201C00F Reserved - - Reserved
0x3201C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3201C011 Reserved - - Reserved
0x3201C012 Reserved - - Reserved
0x3201C013 Reserved - - Reserved
0x3201C014 Reserved - - Reserved
0x3201C015 Reserved - - Reserved
0x3201C016 Reserved - - Reserved
0x3201C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3201C018 Reserved - - Reserved
0x3201C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3201C01A Reserved - - Reserved
0x3201C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3201C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x32020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x32020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x32020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x32020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x32020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x32020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x32020010 Reserved - - Reserved
0x32020011 Reserved - - Reserved
0x32020012 Reserved - - Reserved
0x32020020 Reserved - - Reserved
0x32020021 Reserved - - Reserved
0x32020022 Reserved - - Reserved
0x32020030 Reserved - - Reserved
0x32020031 Reserved - - Reserved
0x32020032 Reserved - - Reserved
0x32020040 Reserved - - Reserved
0x32020041 Reserved - - Reserved
0x32020042 Reserved - - Reserved
0x32020050 Reserved - - Reserved
0x32020051 Reserved - - Reserved
0x32020052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x32040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x32040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x32040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x32040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x32040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x32040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x32040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x32044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x32044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x32044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x32044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x32044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x32044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x32044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x32044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x32044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x32044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3204401A Reserved - - Reserved
0x3204401B Reserved - - Reserved
0x32044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x32044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x32044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x32044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x32044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x32044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x32044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3204402A Reserved - - Reserved
0x3204402B Reserved - - Reserved
0x32044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x32044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x32044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x32044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x32044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x32044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x32044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3204403A Reserved - - Reserved
0x3204403B Reserved - - Reserved
0x32044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x32044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x32044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x32044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x32044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x32044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x32044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3204404A Reserved - - Reserved
0x3204404B Reserved - - Reserved
0x32044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x32044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x32044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x32044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x32044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x32044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x32044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3204405A Reserved - - Reserved
0x3204405B Reserved - - Reserved
0x32044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x32044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x32044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x32044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x32044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x32044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x32044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x32044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x32044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x32044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x32044FF3 Reserved - - Reserved
0x32044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x32080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x32080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x32080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x32080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3208000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3208000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x32080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x32080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x32080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x32080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x32080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x32080040 Reserved - - Reserved
0x32080041 Reserved - - Reserved
0x32080042 Reserved - - Reserved
0x32080043 Reserved - - Reserved
0x32080044 Reserved - - Reserved
0x32080045 Reserved - - Reserved
0x32080050 Reserved - - Reserved
0x32080051 Reserved - - Reserved
0x32080052 Reserved - - Reserved
0x32080053 Reserved - - Reserved
0x32080054 Reserved - - Reserved
0x32080055 Reserved - - Reserved
0x32080060 Reserved - - Reserved
0x32080061 Reserved - - Reserved
0x32080062 Reserved - - Reserved
0x32080063 Reserved - - Reserved
0x32080084 Reserved - - Reserved
0x32080065 Reserved - - Reserved
0x32080070 Reserved - - Reserved
0x32080071 Reserved - - Reserved
0x32080072 Reserved - - Reserved
0x32080073 Reserved - - Reserved
0x32080074 Reserved - - Reserved
0x32080075 Reserved - - Reserved
0x32080080 Reserved - - Reserved
0x32080081 Reserved - - Reserved
0x32080082 Reserved - - Reserved
0x32080083 Reserved - - Reserved
0x32080084 Reserved - - Reserved
0x32080085 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 1) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x32084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x32084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x32084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x32084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3208400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3208400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x32084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x32084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x32084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x32084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x32084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x32084016 Reserved - - Reserved
0x32084017 Reserved - - Reserved
0x32084040 Reserved - - Reserved
0x32084041 Reserved - - Reserved
0x32084042 Reserved - - Reserved
0x32084043 Reserved - - Reserved
0x32084044 Reserved - - Reserved
0x32084045 Reserved - - Reserved
0x32084046 Reserved - - Reserved
0x32084047 Reserved - - Reserved
0x32084050 Reserved - - Reserved
0x32084051 Reserved - - Reserved
0x32084052 Reserved - - Reserved
0x32084053 Reserved - - Reserved
0x32084054 Reserved - - Reserved
0x32084055 Reserved - - Reserved
0x32084056 Reserved - - Reserved
0x32084057 Reserved - - Reserved
0x32084060 Reserved - - Reserved
0x32084061 Reserved - - Reserved
0x32084062 Reserved - - Reserved
0x32084063 Reserved - - Reserved
0x32084074 Reserved - - Reserved
0x32084065 Reserved - - Reserved
0x32084066 Reserved - - Reserved
0x32084067 Reserved - - Reserved
0x32084070 Reserved - - Reserved
0x32084071 Reserved - - Reserved
0x32084072 Reserved - - Reserved
0x32084073 Reserved - - Reserved
0x32084074 Reserved - - Reserved
0x32084075 Reserved - - Reserved
0x32084076 Reserved - - Reserved
0x32084077 Reserved - - Reserved
0x32084080 Reserved - - Reserved
0x32084081 Reserved - - Reserved
0x32084082 Reserved - - Reserved
0x32084083 Reserved - - Reserved
0x32084084 Reserved - - Reserved
0x32084085 Reserved - - Reserved
0x32084086 Reserved - - Reserved
0x32084087 Reserved - - Reserved
0x32084090 Reserved - - Reserved
0x32084091 Reserved - - Reserved
0x32084092 Reserved - - Reserved
0x32084093 Reserved - - Reserved
0x32084094 Reserved - - Reserved
0x32084095 Reserved - - Reserved
0x32084096 Reserved - - Reserved
0x32084097 Reserved - - Reserved
0x320840A0 Reserved - - Reserved
0x320840A1 Reserved - - Reserved
0x320840A2 Reserved - - Reserved
0x320840A3 Reserved - - Reserved
0x320840A4 Reserved - - Reserved
0x320840A5 Reserved - - Reserved
0x320840A6 Reserved - - Reserved
0x320840A7 Reserved - - Reserved
0x320840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x320840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x320840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x320840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x320840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x320840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x320840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x320840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x320840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x320840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x320840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x320840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x320840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x320840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x320840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x320840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x320840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x320840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x320840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x320840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x320840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x320840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x320840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x320840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x320840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x320840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x320840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x320840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x320840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x320840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x320840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x320840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x320840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x320840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x320840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x320840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x320840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x320840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x320840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x32084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x32084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x32084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x32084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x32084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x32084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x32084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x32084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x32084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x32084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x32084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x32084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x32084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x32084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x32084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x32084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 0, virtual port 2) : Sub Blocks

[Back to index]
Start Address Description
0x33000000 Network Interface Parameters for network interface
0x3300C000 Network Interface Parameters for VLAN
0x33018000 Network Interface Parameters for IP4
0x3301C000 Network Interface Parameters for IP4 Statistics
0x33020000 Network Interface Parameters for IP4 status
0x33040000 Network Interface Parameters for ARP entry configuration
0x33044000 Network Interface Parameters for ARP table
0x33080000 Network Interface Parameters for IP6 address configuration
0x33084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x33000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3300C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3300C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3300C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3300C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x33018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x33018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x33018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x33018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x33018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x33018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x33018010 Reserved - - Reserved
0x33018011 Reserved - - Reserved
0x33018012 Reserved - - Reserved
0x33018020 Reserved - - Reserved
0x33018021 Reserved - - Reserved
0x33018022 Reserved - - Reserved
0x33018030 Reserved - - Reserved
0x33018031 Reserved - - Reserved
0x33018032 Reserved - - Reserved
0x33018040 Reserved - - Reserved
0x33018041 Reserved - - Reserved
0x33018042 Reserved - - Reserved
0x33018050 Reserved - - Reserved
0x33018051 Reserved - - Reserved
0x33018052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3301C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3301C001 Reserved - - Reserved
0x3301C002 Reserved - - Reserved
0x3301C003 Reserved - - Reserved
0x3301C004 Reserved - - Reserved
0x3301C005 Reserved - - Reserved
0x3301C006 Reserved - - Reserved
0x3301C007 Reserved - - Reserved
0x3301C008 Reserved - - Reserved
0x3301C009 Reserved - - Reserved
0x3301C00A Reserved - - Reserved
0x3301C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3301C00C Reserved - - Reserved
0x3301C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3301C00E Reserved - - Reserved
0x3301C00F Reserved - - Reserved
0x3301C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3301C011 Reserved - - Reserved
0x3301C012 Reserved - - Reserved
0x3301C013 Reserved - - Reserved
0x3301C014 Reserved - - Reserved
0x3301C015 Reserved - - Reserved
0x3301C016 Reserved - - Reserved
0x3301C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3301C018 Reserved - - Reserved
0x3301C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3301C01A Reserved - - Reserved
0x3301C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3301C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x33020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x33020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x33020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x33020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x33020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x33020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x33020010 Reserved - - Reserved
0x33020011 Reserved - - Reserved
0x33020012 Reserved - - Reserved
0x33020020 Reserved - - Reserved
0x33020021 Reserved - - Reserved
0x33020022 Reserved - - Reserved
0x33020030 Reserved - - Reserved
0x33020031 Reserved - - Reserved
0x33020032 Reserved - - Reserved
0x33020040 Reserved - - Reserved
0x33020041 Reserved - - Reserved
0x33020042 Reserved - - Reserved
0x33020050 Reserved - - Reserved
0x33020051 Reserved - - Reserved
0x33020052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x33040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x33040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x33040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x33040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x33040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x33040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x33040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x33044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x33044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x33044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x33044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x33044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x33044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x33044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x33044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x33044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x33044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3304401A Reserved - - Reserved
0x3304401B Reserved - - Reserved
0x33044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x33044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x33044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x33044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x33044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x33044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x33044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3304402A Reserved - - Reserved
0x3304402B Reserved - - Reserved
0x33044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x33044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x33044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x33044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x33044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x33044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x33044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3304403A Reserved - - Reserved
0x3304403B Reserved - - Reserved
0x33044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x33044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x33044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x33044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x33044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x33044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x33044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3304404A Reserved - - Reserved
0x3304404B Reserved - - Reserved
0x33044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x33044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x33044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x33044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x33044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x33044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x33044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3304405A Reserved - - Reserved
0x3304405B Reserved - - Reserved
0x33044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x33044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x33044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x33044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x33044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x33044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x33044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x33044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x33044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x33044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x33044FF3 Reserved - - Reserved
0x33044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x33080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x33080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x33080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x33080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3308000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3308000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x33080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x33080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x33080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x33080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x33080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x33080040 Reserved - - Reserved
0x33080041 Reserved - - Reserved
0x33080042 Reserved - - Reserved
0x33080043 Reserved - - Reserved
0x33080044 Reserved - - Reserved
0x33080045 Reserved - - Reserved
0x33080050 Reserved - - Reserved
0x33080051 Reserved - - Reserved
0x33080052 Reserved - - Reserved
0x33080053 Reserved - - Reserved
0x33080054 Reserved - - Reserved
0x33080055 Reserved - - Reserved
0x33080060 Reserved - - Reserved
0x33080061 Reserved - - Reserved
0x33080062 Reserved - - Reserved
0x33080063 Reserved - - Reserved
0x33080084 Reserved - - Reserved
0x33080065 Reserved - - Reserved
0x33080070 Reserved - - Reserved
0x33080071 Reserved - - Reserved
0x33080072 Reserved - - Reserved
0x33080073 Reserved - - Reserved
0x33080074 Reserved - - Reserved
0x33080075 Reserved - - Reserved
0x33080080 Reserved - - Reserved
0x33080081 Reserved - - Reserved
0x33080082 Reserved - - Reserved
0x33080083 Reserved - - Reserved
0x33080084 Reserved - - Reserved
0x33080085 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 2) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x33084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x33084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x33084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x33084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3308400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3308400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x33084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x33084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x33084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x33084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x33084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x33084016 Reserved - - Reserved
0x33084017 Reserved - - Reserved
0x33084040 Reserved - - Reserved
0x33084041 Reserved - - Reserved
0x33084042 Reserved - - Reserved
0x33084043 Reserved - - Reserved
0x33084044 Reserved - - Reserved
0x33084045 Reserved - - Reserved
0x33084046 Reserved - - Reserved
0x33084047 Reserved - - Reserved
0x33084050 Reserved - - Reserved
0x33084051 Reserved - - Reserved
0x33084052 Reserved - - Reserved
0x33084053 Reserved - - Reserved
0x33084054 Reserved - - Reserved
0x33084055 Reserved - - Reserved
0x33084056 Reserved - - Reserved
0x33084057 Reserved - - Reserved
0x33084060 Reserved - - Reserved
0x33084061 Reserved - - Reserved
0x33084062 Reserved - - Reserved
0x33084063 Reserved - - Reserved
0x33084074 Reserved - - Reserved
0x33084065 Reserved - - Reserved
0x33084066 Reserved - - Reserved
0x33084067 Reserved - - Reserved
0x33084070 Reserved - - Reserved
0x33084071 Reserved - - Reserved
0x33084072 Reserved - - Reserved
0x33084073 Reserved - - Reserved
0x33084074 Reserved - - Reserved
0x33084075 Reserved - - Reserved
0x33084076 Reserved - - Reserved
0x33084077 Reserved - - Reserved
0x33084080 Reserved - - Reserved
0x33084081 Reserved - - Reserved
0x33084082 Reserved - - Reserved
0x33084083 Reserved - - Reserved
0x33084084 Reserved - - Reserved
0x33084085 Reserved - - Reserved
0x33084086 Reserved - - Reserved
0x33084087 Reserved - - Reserved
0x33084090 Reserved - - Reserved
0x33084091 Reserved - - Reserved
0x33084092 Reserved - - Reserved
0x33084093 Reserved - - Reserved
0x33084094 Reserved - - Reserved
0x33084095 Reserved - - Reserved
0x33084096 Reserved - - Reserved
0x33084097 Reserved - - Reserved
0x330840A0 Reserved - - Reserved
0x330840A1 Reserved - - Reserved
0x330840A2 Reserved - - Reserved
0x330840A3 Reserved - - Reserved
0x330840A4 Reserved - - Reserved
0x330840A5 Reserved - - Reserved
0x330840A6 Reserved - - Reserved
0x330840A7 Reserved - - Reserved
0x330840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x330840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x330840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x330840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x330840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x330840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x330840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x330840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x330840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x330840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x330840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x330840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x330840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x330840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x330840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x330840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x330840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x330840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x330840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x330840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x330840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x330840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x330840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x330840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x330840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x330840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x330840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x330840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x330840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x330840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x330840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x330840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x330840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x330840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x330840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x330840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x330840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x330840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x330840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x33084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x33084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x33084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x33084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x33084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x33084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x33084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x33084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x33084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x33084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x33084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x33084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x33084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x33084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x33084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x33084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 0, virtual port 3) : Sub Blocks

[Back to index]
Start Address Description
0x34000000 Network Interface Parameters for network interface
0x3400C000 Network Interface Parameters for VLAN
0x34018000 Network Interface Parameters for IP4
0x3401C000 Network Interface Parameters for IP4 Statistics
0x34020000 Network Interface Parameters for IP4 status
0x34040000 Network Interface Parameters for ARP entry configuration
0x34044000 Network Interface Parameters for ARP table
0x34080000 Network Interface Parameters for IP6 address configuration
0x34084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x34000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3400C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3400C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3400C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3400C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x34018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x34018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x34018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x34018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x34018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x34018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x34018010 Reserved - - Reserved
0x34018011 Reserved - - Reserved
0x34018012 Reserved - - Reserved
0x34018020 Reserved - - Reserved
0x34018021 Reserved - - Reserved
0x34018022 Reserved - - Reserved
0x34018030 Reserved - - Reserved
0x34018031 Reserved - - Reserved
0x34018032 Reserved - - Reserved
0x34018040 Reserved - - Reserved
0x34018041 Reserved - - Reserved
0x34018042 Reserved - - Reserved
0x34018050 Reserved - - Reserved
0x34018051 Reserved - - Reserved
0x34018052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3401C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3401C001 Reserved - - Reserved
0x3401C002 Reserved - - Reserved
0x3401C003 Reserved - - Reserved
0x3401C004 Reserved - - Reserved
0x3401C005 Reserved - - Reserved
0x3401C006 Reserved - - Reserved
0x3401C007 Reserved - - Reserved
0x3401C008 Reserved - - Reserved
0x3401C009 Reserved - - Reserved
0x3401C00A Reserved - - Reserved
0x3401C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3401C00C Reserved - - Reserved
0x3401C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3401C00E Reserved - - Reserved
0x3401C00F Reserved - - Reserved
0x3401C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3401C011 Reserved - - Reserved
0x3401C012 Reserved - - Reserved
0x3401C013 Reserved - - Reserved
0x3401C014 Reserved - - Reserved
0x3401C015 Reserved - - Reserved
0x3401C016 Reserved - - Reserved
0x3401C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3401C018 Reserved - - Reserved
0x3401C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3401C01A Reserved - - Reserved
0x3401C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3401C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x34020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x34020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x34020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x34020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x34020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x34020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x34020010 Reserved - - Reserved
0x34020011 Reserved - - Reserved
0x34020012 Reserved - - Reserved
0x34020020 Reserved - - Reserved
0x34020021 Reserved - - Reserved
0x34020022 Reserved - - Reserved
0x34020030 Reserved - - Reserved
0x34020031 Reserved - - Reserved
0x34020032 Reserved - - Reserved
0x34020040 Reserved - - Reserved
0x34020041 Reserved - - Reserved
0x34020042 Reserved - - Reserved
0x34020050 Reserved - - Reserved
0x34020051 Reserved - - Reserved
0x34020052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x34040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x34040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x34040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x34040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x34040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x34040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x34040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x34044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x34044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x34044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x34044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x34044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x34044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x34044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x34044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x34044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x34044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3404401A Reserved - - Reserved
0x3404401B Reserved - - Reserved
0x34044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x34044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x34044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x34044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x34044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x34044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x34044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3404402A Reserved - - Reserved
0x3404402B Reserved - - Reserved
0x34044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x34044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x34044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x34044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x34044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x34044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x34044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3404403A Reserved - - Reserved
0x3404403B Reserved - - Reserved
0x34044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x34044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x34044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x34044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x34044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x34044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x34044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3404404A Reserved - - Reserved
0x3404404B Reserved - - Reserved
0x34044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x34044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x34044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x34044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x34044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x34044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x34044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3404405A Reserved - - Reserved
0x3404405B Reserved - - Reserved
0x34044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x34044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x34044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x34044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x34044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x34044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x34044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x34044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x34044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x34044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x34044FF3 Reserved - - Reserved
0x34044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x34080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x34080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x34080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x34080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3408000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3408000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x34080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x34080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x34080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x34080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x34080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x34080040 Reserved - - Reserved
0x34080041 Reserved - - Reserved
0x34080042 Reserved - - Reserved
0x34080043 Reserved - - Reserved
0x34080044 Reserved - - Reserved
0x34080045 Reserved - - Reserved
0x34080050 Reserved - - Reserved
0x34080051 Reserved - - Reserved
0x34080052 Reserved - - Reserved
0x34080053 Reserved - - Reserved
0x34080054 Reserved - - Reserved
0x34080055 Reserved - - Reserved
0x34080060 Reserved - - Reserved
0x34080061 Reserved - - Reserved
0x34080062 Reserved - - Reserved
0x34080063 Reserved - - Reserved
0x34080084 Reserved - - Reserved
0x34080065 Reserved - - Reserved
0x34080070 Reserved - - Reserved
0x34080071 Reserved - - Reserved
0x34080072 Reserved - - Reserved
0x34080073 Reserved - - Reserved
0x34080074 Reserved - - Reserved
0x34080075 Reserved - - Reserved
0x34080080 Reserved - - Reserved
0x34080081 Reserved - - Reserved
0x34080082 Reserved - - Reserved
0x34080083 Reserved - - Reserved
0x34080084 Reserved - - Reserved
0x34080085 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 3) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x34084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x34084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x34084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x34084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3408400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3408400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x34084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x34084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x34084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x34084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x34084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x34084016 Reserved - - Reserved
0x34084017 Reserved - - Reserved
0x34084040 Reserved - - Reserved
0x34084041 Reserved - - Reserved
0x34084042 Reserved - - Reserved
0x34084043 Reserved - - Reserved
0x34084044 Reserved - - Reserved
0x34084045 Reserved - - Reserved
0x34084046 Reserved - - Reserved
0x34084047 Reserved - - Reserved
0x34084050 Reserved - - Reserved
0x34084051 Reserved - - Reserved
0x34084052 Reserved - - Reserved
0x34084053 Reserved - - Reserved
0x34084054 Reserved - - Reserved
0x34084055 Reserved - - Reserved
0x34084056 Reserved - - Reserved
0x34084057 Reserved - - Reserved
0x34084060 Reserved - - Reserved
0x34084061 Reserved - - Reserved
0x34084062 Reserved - - Reserved
0x34084063 Reserved - - Reserved
0x34084074 Reserved - - Reserved
0x34084065 Reserved - - Reserved
0x34084066 Reserved - - Reserved
0x34084067 Reserved - - Reserved
0x34084070 Reserved - - Reserved
0x34084071 Reserved - - Reserved
0x34084072 Reserved - - Reserved
0x34084073 Reserved - - Reserved
0x34084074 Reserved - - Reserved
0x34084075 Reserved - - Reserved
0x34084076 Reserved - - Reserved
0x34084077 Reserved - - Reserved
0x34084080 Reserved - - Reserved
0x34084081 Reserved - - Reserved
0x34084082 Reserved - - Reserved
0x34084083 Reserved - - Reserved
0x34084084 Reserved - - Reserved
0x34084085 Reserved - - Reserved
0x34084086 Reserved - - Reserved
0x34084087 Reserved - - Reserved
0x34084090 Reserved - - Reserved
0x34084091 Reserved - - Reserved
0x34084092 Reserved - - Reserved
0x34084093 Reserved - - Reserved
0x34084094 Reserved - - Reserved
0x34084095 Reserved - - Reserved
0x34084096 Reserved - - Reserved
0x34084097 Reserved - - Reserved
0x340840A0 Reserved - - Reserved
0x340840A1 Reserved - - Reserved
0x340840A2 Reserved - - Reserved
0x340840A3 Reserved - - Reserved
0x340840A4 Reserved - - Reserved
0x340840A5 Reserved - - Reserved
0x340840A6 Reserved - - Reserved
0x340840A7 Reserved - - Reserved
0x340840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x340840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x340840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x340840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x340840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x340840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x340840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x340840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x340840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x340840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x340840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x340840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x340840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x340840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x340840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x340840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x340840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x340840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x340840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x340840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x340840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x340840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x340840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x340840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x340840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x340840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x340840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x340840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x340840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x340840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x340840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x340840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x340840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x340840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x340840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x340840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x340840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x340840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x340840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x34084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x34084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x34084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x34084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x34084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x34084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x34084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x34084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x34084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x34084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x34084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x34084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x34084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x34084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x34084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x34084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 0, virtual port 4) : Sub Blocks

[Back to index]
Start Address Description
0x35000000 Network Interface Parameters for network interface
0x3500C000 Network Interface Parameters for VLAN
0x35018000 Network Interface Parameters for IP4
0x3501C000 Network Interface Parameters for IP4 Statistics
0x35020000 Network Interface Parameters for IP4 status
0x35040000 Network Interface Parameters for ARP entry configuration
0x35044000 Network Interface Parameters for ARP table
0x35080000 Network Interface Parameters for IP6 address configuration
0x35084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x35000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3500C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3500C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3500C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3500C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x35018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x35018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x35018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x35018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x35018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x35018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x35018010 Reserved - - Reserved
0x35018011 Reserved - - Reserved
0x35018012 Reserved - - Reserved
0x35018020 Reserved - - Reserved
0x35018021 Reserved - - Reserved
0x35018022 Reserved - - Reserved
0x35018030 Reserved - - Reserved
0x35018031 Reserved - - Reserved
0x35018032 Reserved - - Reserved
0x35018040 Reserved - - Reserved
0x35018041 Reserved - - Reserved
0x35018042 Reserved - - Reserved
0x35018050 Reserved - - Reserved
0x35018051 Reserved - - Reserved
0x35018052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3501C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3501C001 Reserved - - Reserved
0x3501C002 Reserved - - Reserved
0x3501C003 Reserved - - Reserved
0x3501C004 Reserved - - Reserved
0x3501C005 Reserved - - Reserved
0x3501C006 Reserved - - Reserved
0x3501C007 Reserved - - Reserved
0x3501C008 Reserved - - Reserved
0x3501C009 Reserved - - Reserved
0x3501C00A Reserved - - Reserved
0x3501C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3501C00C Reserved - - Reserved
0x3501C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3501C00E Reserved - - Reserved
0x3501C00F Reserved - - Reserved
0x3501C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3501C011 Reserved - - Reserved
0x3501C012 Reserved - - Reserved
0x3501C013 Reserved - - Reserved
0x3501C014 Reserved - - Reserved
0x3501C015 Reserved - - Reserved
0x3501C016 Reserved - - Reserved
0x3501C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3501C018 Reserved - - Reserved
0x3501C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3501C01A Reserved - - Reserved
0x3501C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3501C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x35020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x35020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x35020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x35020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x35020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x35020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x35020010 Reserved - - Reserved
0x35020011 Reserved - - Reserved
0x35020012 Reserved - - Reserved
0x35020020 Reserved - - Reserved
0x35020021 Reserved - - Reserved
0x35020022 Reserved - - Reserved
0x35020030 Reserved - - Reserved
0x35020031 Reserved - - Reserved
0x35020032 Reserved - - Reserved
0x35020040 Reserved - - Reserved
0x35020041 Reserved - - Reserved
0x35020042 Reserved - - Reserved
0x35020050 Reserved - - Reserved
0x35020051 Reserved - - Reserved
0x35020052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x35040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x35040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x35040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x35040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x35040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x35040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x35040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x35044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x35044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x35044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x35044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x35044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x35044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x35044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x35044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x35044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x35044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3504401A Reserved - - Reserved
0x3504401B Reserved - - Reserved
0x35044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x35044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x35044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x35044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x35044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x35044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x35044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3504402A Reserved - - Reserved
0x3504402B Reserved - - Reserved
0x35044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x35044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x35044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x35044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x35044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x35044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x35044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3504403A Reserved - - Reserved
0x3504403B Reserved - - Reserved
0x35044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x35044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x35044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x35044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x35044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x35044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x35044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3504404A Reserved - - Reserved
0x3504404B Reserved - - Reserved
0x35044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x35044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x35044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x35044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x35044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x35044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x35044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3504405A Reserved - - Reserved
0x3504405B Reserved - - Reserved
0x35044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x35044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x35044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x35044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x35044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x35044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x35044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x35044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x35044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x35044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x35044FF3 Reserved - - Reserved
0x35044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x35080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x35080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x35080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x35080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3508000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3508000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x35080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x35080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x35080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x35080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x35080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x35080040 Reserved - - Reserved
0x35080041 Reserved - - Reserved
0x35080042 Reserved - - Reserved
0x35080043 Reserved - - Reserved
0x35080044 Reserved - - Reserved
0x35080045 Reserved - - Reserved
0x35080050 Reserved - - Reserved
0x35080051 Reserved - - Reserved
0x35080052 Reserved - - Reserved
0x35080053 Reserved - - Reserved
0x35080054 Reserved - - Reserved
0x35080055 Reserved - - Reserved
0x35080060 Reserved - - Reserved
0x35080061 Reserved - - Reserved
0x35080062 Reserved - - Reserved
0x35080063 Reserved - - Reserved
0x35080084 Reserved - - Reserved
0x35080065 Reserved - - Reserved
0x35080070 Reserved - - Reserved
0x35080071 Reserved - - Reserved
0x35080072 Reserved - - Reserved
0x35080073 Reserved - - Reserved
0x35080074 Reserved - - Reserved
0x35080075 Reserved - - Reserved
0x35080080 Reserved - - Reserved
0x35080081 Reserved - - Reserved
0x35080082 Reserved - - Reserved
0x35080083 Reserved - - Reserved
0x35080084 Reserved - - Reserved
0x35080085 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 4) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x35084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x35084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x35084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x35084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3508400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3508400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x35084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x35084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x35084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x35084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x35084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x35084016 Reserved - - Reserved
0x35084017 Reserved - - Reserved
0x35084040 Reserved - - Reserved
0x35084041 Reserved - - Reserved
0x35084042 Reserved - - Reserved
0x35084043 Reserved - - Reserved
0x35084044 Reserved - - Reserved
0x35084045 Reserved - - Reserved
0x35084046 Reserved - - Reserved
0x35084047 Reserved - - Reserved
0x35084050 Reserved - - Reserved
0x35084051 Reserved - - Reserved
0x35084052 Reserved - - Reserved
0x35084053 Reserved - - Reserved
0x35084054 Reserved - - Reserved
0x35084055 Reserved - - Reserved
0x35084056 Reserved - - Reserved
0x35084057 Reserved - - Reserved
0x35084060 Reserved - - Reserved
0x35084061 Reserved - - Reserved
0x35084062 Reserved - - Reserved
0x35084063 Reserved - - Reserved
0x35084074 Reserved - - Reserved
0x35084065 Reserved - - Reserved
0x35084066 Reserved - - Reserved
0x35084067 Reserved - - Reserved
0x35084070 Reserved - - Reserved
0x35084071 Reserved - - Reserved
0x35084072 Reserved - - Reserved
0x35084073 Reserved - - Reserved
0x35084074 Reserved - - Reserved
0x35084075 Reserved - - Reserved
0x35084076 Reserved - - Reserved
0x35084077 Reserved - - Reserved
0x35084080 Reserved - - Reserved
0x35084081 Reserved - - Reserved
0x35084082 Reserved - - Reserved
0x35084083 Reserved - - Reserved
0x35084084 Reserved - - Reserved
0x35084085 Reserved - - Reserved
0x35084086 Reserved - - Reserved
0x35084087 Reserved - - Reserved
0x35084090 Reserved - - Reserved
0x35084091 Reserved - - Reserved
0x35084092 Reserved - - Reserved
0x35084093 Reserved - - Reserved
0x35084094 Reserved - - Reserved
0x35084095 Reserved - - Reserved
0x35084096 Reserved - - Reserved
0x35084097 Reserved - - Reserved
0x350840A0 Reserved - - Reserved
0x350840A1 Reserved - - Reserved
0x350840A2 Reserved - - Reserved
0x350840A3 Reserved - - Reserved
0x350840A4 Reserved - - Reserved
0x350840A5 Reserved - - Reserved
0x350840A6 Reserved - - Reserved
0x350840A7 Reserved - - Reserved
0x350840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x350840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x350840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x350840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x350840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x350840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x350840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x350840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x350840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x350840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x350840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x350840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x350840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x350840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x350840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x350840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x350840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x350840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x350840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x350840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x350840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x350840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x350840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x350840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x350840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x350840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x350840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x350840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x350840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x350840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x350840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x350840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x350840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x350840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x350840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x350840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x350840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x350840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x350840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x35084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x35084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x35084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x35084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x35084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x35084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x35084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x35084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x35084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x35084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x35084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x35084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x35084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x35084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x35084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x35084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 0, virtual port 5) : Sub Blocks

[Back to index]
Start Address Description
0x36000000 Network Interface Parameters for network interface
0x3600C000 Network Interface Parameters for VLAN
0x36018000 Network Interface Parameters for IP4
0x3601C000 Network Interface Parameters for IP4 Statistics
0x36020000 Network Interface Parameters for IP4 status
0x36040000 Network Interface Parameters for ARP entry configuration
0x36044000 Network Interface Parameters for ARP table
0x36080000 Network Interface Parameters for IP6 address configuration
0x36084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x36000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3600C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3600C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3600C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3600C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x36018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x36018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x36018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x36018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x36018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x36018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x36018010 Reserved - - Reserved
0x36018011 Reserved - - Reserved
0x36018012 Reserved - - Reserved
0x36018020 Reserved - - Reserved
0x36018021 Reserved - - Reserved
0x36018022 Reserved - - Reserved
0x36018030 Reserved - - Reserved
0x36018031 Reserved - - Reserved
0x36018032 Reserved - - Reserved
0x36018040 Reserved - - Reserved
0x36018041 Reserved - - Reserved
0x36018042 Reserved - - Reserved
0x36018050 Reserved - - Reserved
0x36018051 Reserved - - Reserved
0x36018052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3601C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3601C001 Reserved - - Reserved
0x3601C002 Reserved - - Reserved
0x3601C003 Reserved - - Reserved
0x3601C004 Reserved - - Reserved
0x3601C005 Reserved - - Reserved
0x3601C006 Reserved - - Reserved
0x3601C007 Reserved - - Reserved
0x3601C008 Reserved - - Reserved
0x3601C009 Reserved - - Reserved
0x3601C00A Reserved - - Reserved
0x3601C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3601C00C Reserved - - Reserved
0x3601C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3601C00E Reserved - - Reserved
0x3601C00F Reserved - - Reserved
0x3601C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3601C011 Reserved - - Reserved
0x3601C012 Reserved - - Reserved
0x3601C013 Reserved - - Reserved
0x3601C014 Reserved - - Reserved
0x3601C015 Reserved - - Reserved
0x3601C016 Reserved - - Reserved
0x3601C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3601C018 Reserved - - Reserved
0x3601C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3601C01A Reserved - - Reserved
0x3601C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3601C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x36020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x36020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x36020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x36020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x36020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x36020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x36020010 Reserved - - Reserved
0x36020011 Reserved - - Reserved
0x36020012 Reserved - - Reserved
0x36020020 Reserved - - Reserved
0x36020021 Reserved - - Reserved
0x36020022 Reserved - - Reserved
0x36020030 Reserved - - Reserved
0x36020031 Reserved - - Reserved
0x36020032 Reserved - - Reserved
0x36020040 Reserved - - Reserved
0x36020041 Reserved - - Reserved
0x36020042 Reserved - - Reserved
0x36020050 Reserved - - Reserved
0x36020051 Reserved - - Reserved
0x36020052 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x36040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x36040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x36040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x36040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x36040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x36040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x36040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x36044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x36044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x36044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x36044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x36044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x36044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x36044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x36044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x36044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x36044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3604401A Reserved - - Reserved
0x3604401B Reserved - - Reserved
0x36044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x36044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x36044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x36044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x36044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x36044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x36044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3604402A Reserved - - Reserved
0x3604402B Reserved - - Reserved
0x36044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x36044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x36044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x36044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x36044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x36044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x36044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3604403A Reserved - - Reserved
0x3604403B Reserved - - Reserved
0x36044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x36044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x36044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x36044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x36044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x36044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x36044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3604404A Reserved - - Reserved
0x3604404B Reserved - - Reserved
0x36044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x36044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x36044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x36044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x36044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x36044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x36044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3604405A Reserved - - Reserved
0x3604405B Reserved - - Reserved
0x36044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x36044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x36044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x36044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x36044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x36044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x36044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x36044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x36044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x36044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x36044FF3 Reserved - - Reserved
0x36044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x36080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x36080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x36080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x36080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3608000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3608000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x36080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x36080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x36080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x36080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x36080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x36080040 Reserved - - Reserved
0x36080041 Reserved - - Reserved
0x36080042 Reserved - - Reserved
0x36080043 Reserved - - Reserved
0x36080044 Reserved - - Reserved
0x36080045 Reserved - - Reserved
0x36080050 Reserved - - Reserved
0x36080051 Reserved - - Reserved
0x36080052 Reserved - - Reserved
0x36080053 Reserved - - Reserved
0x36080054 Reserved - - Reserved
0x36080055 Reserved - - Reserved
0x36080060 Reserved - - Reserved
0x36080061 Reserved - - Reserved
0x36080062 Reserved - - Reserved
0x36080063 Reserved - - Reserved
0x36080084 Reserved - - Reserved
0x36080065 Reserved - - Reserved
0x36080070 Reserved - - Reserved
0x36080071 Reserved - - Reserved
0x36080072 Reserved - - Reserved
0x36080073 Reserved - - Reserved
0x36080074 Reserved - - Reserved
0x36080075 Reserved - - Reserved
0x36080080 Reserved - - Reserved
0x36080081 Reserved - - Reserved
0x36080082 Reserved - - Reserved
0x36080083 Reserved - - Reserved
0x36080084 Reserved - - Reserved
0x36080085 Reserved - - Reserved

Virtual interface Configuration (physical port 0, virtual port 5) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x36084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x36084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x36084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x36084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3608400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3608400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x36084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x36084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x36084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x36084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x36084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x36084016 Reserved - - Reserved
0x36084017 Reserved - - Reserved
0x36084040 Reserved - - Reserved
0x36084041 Reserved - - Reserved
0x36084042 Reserved - - Reserved
0x36084043 Reserved - - Reserved
0x36084044 Reserved - - Reserved
0x36084045 Reserved - - Reserved
0x36084046 Reserved - - Reserved
0x36084047 Reserved - - Reserved
0x36084050 Reserved - - Reserved
0x36084051 Reserved - - Reserved
0x36084052 Reserved - - Reserved
0x36084053 Reserved - - Reserved
0x36084054 Reserved - - Reserved
0x36084055 Reserved - - Reserved
0x36084056 Reserved - - Reserved
0x36084057 Reserved - - Reserved
0x36084060 Reserved - - Reserved
0x36084061 Reserved - - Reserved
0x36084062 Reserved - - Reserved
0x36084063 Reserved - - Reserved
0x36084074 Reserved - - Reserved
0x36084065 Reserved - - Reserved
0x36084066 Reserved - - Reserved
0x36084067 Reserved - - Reserved
0x36084070 Reserved - - Reserved
0x36084071 Reserved - - Reserved
0x36084072 Reserved - - Reserved
0x36084073 Reserved - - Reserved
0x36084074 Reserved - - Reserved
0x36084075 Reserved - - Reserved
0x36084076 Reserved - - Reserved
0x36084077 Reserved - - Reserved
0x36084080 Reserved - - Reserved
0x36084081 Reserved - - Reserved
0x36084082 Reserved - - Reserved
0x36084083 Reserved - - Reserved
0x36084084 Reserved - - Reserved
0x36084085 Reserved - - Reserved
0x36084086 Reserved - - Reserved
0x36084087 Reserved - - Reserved
0x36084090 Reserved - - Reserved
0x36084091 Reserved - - Reserved
0x36084092 Reserved - - Reserved
0x36084093 Reserved - - Reserved
0x36084094 Reserved - - Reserved
0x36084095 Reserved - - Reserved
0x36084096 Reserved - - Reserved
0x36084097 Reserved - - Reserved
0x360840A0 Reserved - - Reserved
0x360840A1 Reserved - - Reserved
0x360840A2 Reserved - - Reserved
0x360840A3 Reserved - - Reserved
0x360840A4 Reserved - - Reserved
0x360840A5 Reserved - - Reserved
0x360840A6 Reserved - - Reserved
0x360840A7 Reserved - - Reserved
0x360840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x360840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x360840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x360840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x360840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x360840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x360840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x360840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x360840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x360840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x360840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x360840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x360840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x360840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x360840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x360840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x360840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x360840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x360840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x360840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x360840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x360840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x360840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x360840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x360840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x360840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x360840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x360840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x360840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x360840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x360840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x360840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x360840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x360840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x360840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x360840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x360840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x360840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x360840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x36084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x36084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x36084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x36084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x36084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x36084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x36084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x36084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x36084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x36084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x36084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x36084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x36084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x36084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x36084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x36084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 1, virtual port 1) : Sub Blocks

[Back to index]
Start Address Description
0x3C000000 Network Interface Parameters for network interface
0x3C00C000 Network Interface Parameters for VLAN
0x3C018000 Network Interface Parameters for IP4
0x3C01C000 Network Interface Parameters for IP4 Statistics
0x3C020000 Network Interface Parameters for IP4 status
0x3C040000 Network Interface Parameters for ARP entry configuration
0x3C044000 Network Interface Parameters for ARP table
0x3C080000 Network Interface Parameters for IP6 address configuration
0x3C084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C00C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3C00C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3C00C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3C00C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3C018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x3C018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3C018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x3C018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x3C018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3C018010 Reserved - - Reserved
0x3C018011 Reserved - - Reserved
0x3C018012 Reserved - - Reserved
0x3C018020 Reserved - - Reserved
0x3C018021 Reserved - - Reserved
0x3C018022 Reserved - - Reserved
0x3C018030 Reserved - - Reserved
0x3C018031 Reserved - - Reserved
0x3C018032 Reserved - - Reserved
0x3C018040 Reserved - - Reserved
0x3C018041 Reserved - - Reserved
0x3C018042 Reserved - - Reserved
0x3C018050 Reserved - - Reserved
0x3C018051 Reserved - - Reserved
0x3C018052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C01C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3C01C001 Reserved - - Reserved
0x3C01C002 Reserved - - Reserved
0x3C01C003 Reserved - - Reserved
0x3C01C004 Reserved - - Reserved
0x3C01C005 Reserved - - Reserved
0x3C01C006 Reserved - - Reserved
0x3C01C007 Reserved - - Reserved
0x3C01C008 Reserved - - Reserved
0x3C01C009 Reserved - - Reserved
0x3C01C00A Reserved - - Reserved
0x3C01C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3C01C00C Reserved - - Reserved
0x3C01C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3C01C00E Reserved - - Reserved
0x3C01C00F Reserved - - Reserved
0x3C01C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3C01C011 Reserved - - Reserved
0x3C01C012 Reserved - - Reserved
0x3C01C013 Reserved - - Reserved
0x3C01C014 Reserved - - Reserved
0x3C01C015 Reserved - - Reserved
0x3C01C016 Reserved - - Reserved
0x3C01C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3C01C018 Reserved - - Reserved
0x3C01C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3C01C01A Reserved - - Reserved
0x3C01C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3C01C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x3C020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x3C020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x3C020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x3C020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x3C020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x3C020010 Reserved - - Reserved
0x3C020011 Reserved - - Reserved
0x3C020012 Reserved - - Reserved
0x3C020020 Reserved - - Reserved
0x3C020021 Reserved - - Reserved
0x3C020022 Reserved - - Reserved
0x3C020030 Reserved - - Reserved
0x3C020031 Reserved - - Reserved
0x3C020032 Reserved - - Reserved
0x3C020040 Reserved - - Reserved
0x3C020041 Reserved - - Reserved
0x3C020042 Reserved - - Reserved
0x3C020050 Reserved - - Reserved
0x3C020051 Reserved - - Reserved
0x3C020052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x3C040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3C040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x3C040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x3C040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x3C040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x3C040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x3C044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3C044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x3C044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3C044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3C044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3C044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3C044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3C044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3C044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3C04401A Reserved - - Reserved
0x3C04401B Reserved - - Reserved
0x3C044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3C044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3C044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3C044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3C044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3C044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3C044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3C04402A Reserved - - Reserved
0x3C04402B Reserved - - Reserved
0x3C044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3C044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3C044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3C044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3C044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3C044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3C044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3C04403A Reserved - - Reserved
0x3C04403B Reserved - - Reserved
0x3C044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3C044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3C044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3C044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3C044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3C044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3C044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3C04404A Reserved - - Reserved
0x3C04404B Reserved - - Reserved
0x3C044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3C044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3C044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3C044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3C044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3C044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3C044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3C04405A Reserved - - Reserved
0x3C04405B Reserved - - Reserved
0x3C044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3C044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3C044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3C044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3C044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3C044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3C044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3C044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3C044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3C044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3C044FF3 Reserved - - Reserved
0x3C044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3C080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x3C080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3C080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3C08000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3C08000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3C080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3C080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3C080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3C080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3C080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3C080040 Reserved - - Reserved
0x3C080041 Reserved - - Reserved
0x3C080042 Reserved - - Reserved
0x3C080043 Reserved - - Reserved
0x3C080044 Reserved - - Reserved
0x3C080045 Reserved - - Reserved
0x3C080050 Reserved - - Reserved
0x3C080051 Reserved - - Reserved
0x3C080052 Reserved - - Reserved
0x3C080053 Reserved - - Reserved
0x3C080054 Reserved - - Reserved
0x3C080055 Reserved - - Reserved
0x3C080060 Reserved - - Reserved
0x3C080061 Reserved - - Reserved
0x3C080062 Reserved - - Reserved
0x3C080063 Reserved - - Reserved
0x3C080084 Reserved - - Reserved
0x3C080065 Reserved - - Reserved
0x3C080070 Reserved - - Reserved
0x3C080071 Reserved - - Reserved
0x3C080072 Reserved - - Reserved
0x3C080073 Reserved - - Reserved
0x3C080074 Reserved - - Reserved
0x3C080075 Reserved - - Reserved
0x3C080080 Reserved - - Reserved
0x3C080081 Reserved - - Reserved
0x3C080082 Reserved - - Reserved
0x3C080083 Reserved - - Reserved
0x3C080084 Reserved - - Reserved
0x3C080085 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 1) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3C084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x3C084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x3C084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x3C084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3C08400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3C08400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x3C084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x3C084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x3C084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x3C084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x3C084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x3C084016 Reserved - - Reserved
0x3C084017 Reserved - - Reserved
0x3C084040 Reserved - - Reserved
0x3C084041 Reserved - - Reserved
0x3C084042 Reserved - - Reserved
0x3C084043 Reserved - - Reserved
0x3C084044 Reserved - - Reserved
0x3C084045 Reserved - - Reserved
0x3C084046 Reserved - - Reserved
0x3C084047 Reserved - - Reserved
0x3C084050 Reserved - - Reserved
0x3C084051 Reserved - - Reserved
0x3C084052 Reserved - - Reserved
0x3C084053 Reserved - - Reserved
0x3C084054 Reserved - - Reserved
0x3C084055 Reserved - - Reserved
0x3C084056 Reserved - - Reserved
0x3C084057 Reserved - - Reserved
0x3C084060 Reserved - - Reserved
0x3C084061 Reserved - - Reserved
0x3C084062 Reserved - - Reserved
0x3C084063 Reserved - - Reserved
0x3C084074 Reserved - - Reserved
0x3C084065 Reserved - - Reserved
0x3C084066 Reserved - - Reserved
0x3C084067 Reserved - - Reserved
0x3C084070 Reserved - - Reserved
0x3C084071 Reserved - - Reserved
0x3C084072 Reserved - - Reserved
0x3C084073 Reserved - - Reserved
0x3C084074 Reserved - - Reserved
0x3C084075 Reserved - - Reserved
0x3C084076 Reserved - - Reserved
0x3C084077 Reserved - - Reserved
0x3C084080 Reserved - - Reserved
0x3C084081 Reserved - - Reserved
0x3C084082 Reserved - - Reserved
0x3C084083 Reserved - - Reserved
0x3C084084 Reserved - - Reserved
0x3C084085 Reserved - - Reserved
0x3C084086 Reserved - - Reserved
0x3C084087 Reserved - - Reserved
0x3C084090 Reserved - - Reserved
0x3C084091 Reserved - - Reserved
0x3C084092 Reserved - - Reserved
0x3C084093 Reserved - - Reserved
0x3C084094 Reserved - - Reserved
0x3C084095 Reserved - - Reserved
0x3C084096 Reserved - - Reserved
0x3C084097 Reserved - - Reserved
0x3C0840A0 Reserved - - Reserved
0x3C0840A1 Reserved - - Reserved
0x3C0840A2 Reserved - - Reserved
0x3C0840A3 Reserved - - Reserved
0x3C0840A4 Reserved - - Reserved
0x3C0840A5 Reserved - - Reserved
0x3C0840A6 Reserved - - Reserved
0x3C0840A7 Reserved - - Reserved
0x3C0840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x3C0840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x3C0840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x3C0840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x3C0840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x3C0840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x3C0840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x3C0840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x3C0840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x3C0840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x3C0840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x3C0840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x3C0840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x3C0840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x3C0840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x3C0840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x3C0840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x3C0840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x3C0840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x3C0840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x3C0840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x3C0840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x3C0840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x3C0840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x3C0840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x3C0840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x3C0840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x3C0840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x3C0840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x3C0840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x3C0840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x3C0840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x3C0840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x3C0840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x3C0840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x3C0840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x3C0840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x3C0840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x3C0840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x3C084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x3C084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x3C084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x3C084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x3C084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x3C084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x3C084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x3C084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x3C084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x3C084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x3C084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x3C084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x3C084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x3C084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x3C084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x3C084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 1, virtual port 2) : Sub Blocks

[Back to index]
Start Address Description
0x3D000000 Network Interface Parameters for network interface
0x3D00C000 Network Interface Parameters for VLAN
0x3D018000 Network Interface Parameters for IP4
0x3D01C000 Network Interface Parameters for IP4 Statistics
0x3D020000 Network Interface Parameters for IP4 status
0x3D040000 Network Interface Parameters for ARP entry configuration
0x3D044000 Network Interface Parameters for ARP table
0x3D080000 Network Interface Parameters for IP6 address configuration
0x3D084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D00C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3D00C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3D00C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3D00C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3D018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x3D018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3D018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x3D018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x3D018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3D018010 Reserved - - Reserved
0x3D018011 Reserved - - Reserved
0x3D018012 Reserved - - Reserved
0x3D018020 Reserved - - Reserved
0x3D018021 Reserved - - Reserved
0x3D018022 Reserved - - Reserved
0x3D018030 Reserved - - Reserved
0x3D018031 Reserved - - Reserved
0x3D018032 Reserved - - Reserved
0x3D018040 Reserved - - Reserved
0x3D018041 Reserved - - Reserved
0x3D018042 Reserved - - Reserved
0x3D018050 Reserved - - Reserved
0x3D018051 Reserved - - Reserved
0x3D018052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D01C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3D01C001 Reserved - - Reserved
0x3D01C002 Reserved - - Reserved
0x3D01C003 Reserved - - Reserved
0x3D01C004 Reserved - - Reserved
0x3D01C005 Reserved - - Reserved
0x3D01C006 Reserved - - Reserved
0x3D01C007 Reserved - - Reserved
0x3D01C008 Reserved - - Reserved
0x3D01C009 Reserved - - Reserved
0x3D01C00A Reserved - - Reserved
0x3D01C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3D01C00C Reserved - - Reserved
0x3D01C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3D01C00E Reserved - - Reserved
0x3D01C00F Reserved - - Reserved
0x3D01C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3D01C011 Reserved - - Reserved
0x3D01C012 Reserved - - Reserved
0x3D01C013 Reserved - - Reserved
0x3D01C014 Reserved - - Reserved
0x3D01C015 Reserved - - Reserved
0x3D01C016 Reserved - - Reserved
0x3D01C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3D01C018 Reserved - - Reserved
0x3D01C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3D01C01A Reserved - - Reserved
0x3D01C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3D01C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x3D020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x3D020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x3D020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x3D020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x3D020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x3D020010 Reserved - - Reserved
0x3D020011 Reserved - - Reserved
0x3D020012 Reserved - - Reserved
0x3D020020 Reserved - - Reserved
0x3D020021 Reserved - - Reserved
0x3D020022 Reserved - - Reserved
0x3D020030 Reserved - - Reserved
0x3D020031 Reserved - - Reserved
0x3D020032 Reserved - - Reserved
0x3D020040 Reserved - - Reserved
0x3D020041 Reserved - - Reserved
0x3D020042 Reserved - - Reserved
0x3D020050 Reserved - - Reserved
0x3D020051 Reserved - - Reserved
0x3D020052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x3D040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3D040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x3D040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x3D040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x3D040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x3D040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x3D044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3D044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x3D044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3D044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3D044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3D044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3D044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3D044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3D044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3D04401A Reserved - - Reserved
0x3D04401B Reserved - - Reserved
0x3D044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3D044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3D044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3D044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3D044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3D044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3D044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3D04402A Reserved - - Reserved
0x3D04402B Reserved - - Reserved
0x3D044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3D044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3D044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3D044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3D044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3D044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3D044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3D04403A Reserved - - Reserved
0x3D04403B Reserved - - Reserved
0x3D044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3D044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3D044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3D044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3D044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3D044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3D044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3D04404A Reserved - - Reserved
0x3D04404B Reserved - - Reserved
0x3D044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3D044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3D044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3D044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3D044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3D044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3D044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3D04405A Reserved - - Reserved
0x3D04405B Reserved - - Reserved
0x3D044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3D044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3D044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3D044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3D044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3D044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3D044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3D044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3D044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3D044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3D044FF3 Reserved - - Reserved
0x3D044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3D080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x3D080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3D080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3D08000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3D08000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3D080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3D080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3D080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3D080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3D080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3D080040 Reserved - - Reserved
0x3D080041 Reserved - - Reserved
0x3D080042 Reserved - - Reserved
0x3D080043 Reserved - - Reserved
0x3D080044 Reserved - - Reserved
0x3D080045 Reserved - - Reserved
0x3D080050 Reserved - - Reserved
0x3D080051 Reserved - - Reserved
0x3D080052 Reserved - - Reserved
0x3D080053 Reserved - - Reserved
0x3D080054 Reserved - - Reserved
0x3D080055 Reserved - - Reserved
0x3D080060 Reserved - - Reserved
0x3D080061 Reserved - - Reserved
0x3D080062 Reserved - - Reserved
0x3D080063 Reserved - - Reserved
0x3D080084 Reserved - - Reserved
0x3D080065 Reserved - - Reserved
0x3D080070 Reserved - - Reserved
0x3D080071 Reserved - - Reserved
0x3D080072 Reserved - - Reserved
0x3D080073 Reserved - - Reserved
0x3D080074 Reserved - - Reserved
0x3D080075 Reserved - - Reserved
0x3D080080 Reserved - - Reserved
0x3D080081 Reserved - - Reserved
0x3D080082 Reserved - - Reserved
0x3D080083 Reserved - - Reserved
0x3D080084 Reserved - - Reserved
0x3D080085 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 2) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3D084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x3D084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x3D084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x3D084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3D08400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3D08400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x3D084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x3D084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x3D084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x3D084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x3D084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x3D084016 Reserved - - Reserved
0x3D084017 Reserved - - Reserved
0x3D084040 Reserved - - Reserved
0x3D084041 Reserved - - Reserved
0x3D084042 Reserved - - Reserved
0x3D084043 Reserved - - Reserved
0x3D084044 Reserved - - Reserved
0x3D084045 Reserved - - Reserved
0x3D084046 Reserved - - Reserved
0x3D084047 Reserved - - Reserved
0x3D084050 Reserved - - Reserved
0x3D084051 Reserved - - Reserved
0x3D084052 Reserved - - Reserved
0x3D084053 Reserved - - Reserved
0x3D084054 Reserved - - Reserved
0x3D084055 Reserved - - Reserved
0x3D084056 Reserved - - Reserved
0x3D084057 Reserved - - Reserved
0x3D084060 Reserved - - Reserved
0x3D084061 Reserved - - Reserved
0x3D084062 Reserved - - Reserved
0x3D084063 Reserved - - Reserved
0x3D084074 Reserved - - Reserved
0x3D084065 Reserved - - Reserved
0x3D084066 Reserved - - Reserved
0x3D084067 Reserved - - Reserved
0x3D084070 Reserved - - Reserved
0x3D084071 Reserved - - Reserved
0x3D084072 Reserved - - Reserved
0x3D084073 Reserved - - Reserved
0x3D084074 Reserved - - Reserved
0x3D084075 Reserved - - Reserved
0x3D084076 Reserved - - Reserved
0x3D084077 Reserved - - Reserved
0x3D084080 Reserved - - Reserved
0x3D084081 Reserved - - Reserved
0x3D084082 Reserved - - Reserved
0x3D084083 Reserved - - Reserved
0x3D084084 Reserved - - Reserved
0x3D084085 Reserved - - Reserved
0x3D084086 Reserved - - Reserved
0x3D084087 Reserved - - Reserved
0x3D084090 Reserved - - Reserved
0x3D084091 Reserved - - Reserved
0x3D084092 Reserved - - Reserved
0x3D084093 Reserved - - Reserved
0x3D084094 Reserved - - Reserved
0x3D084095 Reserved - - Reserved
0x3D084096 Reserved - - Reserved
0x3D084097 Reserved - - Reserved
0x3D0840A0 Reserved - - Reserved
0x3D0840A1 Reserved - - Reserved
0x3D0840A2 Reserved - - Reserved
0x3D0840A3 Reserved - - Reserved
0x3D0840A4 Reserved - - Reserved
0x3D0840A5 Reserved - - Reserved
0x3D0840A6 Reserved - - Reserved
0x3D0840A7 Reserved - - Reserved
0x3D0840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x3D0840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x3D0840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x3D0840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x3D0840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x3D0840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x3D0840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x3D0840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x3D0840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x3D0840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x3D0840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x3D0840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x3D0840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x3D0840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x3D0840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x3D0840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x3D0840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x3D0840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x3D0840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x3D0840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x3D0840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x3D0840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x3D0840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x3D0840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x3D0840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x3D0840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x3D0840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x3D0840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x3D0840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x3D0840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x3D0840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x3D0840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x3D0840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x3D0840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x3D0840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x3D0840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x3D0840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x3D0840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x3D0840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x3D084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x3D084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x3D084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x3D084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x3D084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x3D084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x3D084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x3D084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x3D084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x3D084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x3D084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x3D084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x3D084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x3D084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x3D084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x3D084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 1, virtual port 3) : Sub Blocks

[Back to index]
Start Address Description
0x3E000000 Network Interface Parameters for network interface
0x3E00C000 Network Interface Parameters for VLAN
0x3E018000 Network Interface Parameters for IP4
0x3E01C000 Network Interface Parameters for IP4 Statistics
0x3E020000 Network Interface Parameters for IP4 status
0x3E040000 Network Interface Parameters for ARP entry configuration
0x3E044000 Network Interface Parameters for ARP table
0x3E080000 Network Interface Parameters for IP6 address configuration
0x3E084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E00C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3E00C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3E00C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3E00C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3E018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x3E018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3E018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x3E018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x3E018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3E018010 Reserved - - Reserved
0x3E018011 Reserved - - Reserved
0x3E018012 Reserved - - Reserved
0x3E018020 Reserved - - Reserved
0x3E018021 Reserved - - Reserved
0x3E018022 Reserved - - Reserved
0x3E018030 Reserved - - Reserved
0x3E018031 Reserved - - Reserved
0x3E018032 Reserved - - Reserved
0x3E018040 Reserved - - Reserved
0x3E018041 Reserved - - Reserved
0x3E018042 Reserved - - Reserved
0x3E018050 Reserved - - Reserved
0x3E018051 Reserved - - Reserved
0x3E018052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E01C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3E01C001 Reserved - - Reserved
0x3E01C002 Reserved - - Reserved
0x3E01C003 Reserved - - Reserved
0x3E01C004 Reserved - - Reserved
0x3E01C005 Reserved - - Reserved
0x3E01C006 Reserved - - Reserved
0x3E01C007 Reserved - - Reserved
0x3E01C008 Reserved - - Reserved
0x3E01C009 Reserved - - Reserved
0x3E01C00A Reserved - - Reserved
0x3E01C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3E01C00C Reserved - - Reserved
0x3E01C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3E01C00E Reserved - - Reserved
0x3E01C00F Reserved - - Reserved
0x3E01C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3E01C011 Reserved - - Reserved
0x3E01C012 Reserved - - Reserved
0x3E01C013 Reserved - - Reserved
0x3E01C014 Reserved - - Reserved
0x3E01C015 Reserved - - Reserved
0x3E01C016 Reserved - - Reserved
0x3E01C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3E01C018 Reserved - - Reserved
0x3E01C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3E01C01A Reserved - - Reserved
0x3E01C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3E01C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x3E020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x3E020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x3E020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x3E020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x3E020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x3E020010 Reserved - - Reserved
0x3E020011 Reserved - - Reserved
0x3E020012 Reserved - - Reserved
0x3E020020 Reserved - - Reserved
0x3E020021 Reserved - - Reserved
0x3E020022 Reserved - - Reserved
0x3E020030 Reserved - - Reserved
0x3E020031 Reserved - - Reserved
0x3E020032 Reserved - - Reserved
0x3E020040 Reserved - - Reserved
0x3E020041 Reserved - - Reserved
0x3E020042 Reserved - - Reserved
0x3E020050 Reserved - - Reserved
0x3E020051 Reserved - - Reserved
0x3E020052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x3E040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3E040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x3E040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x3E040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x3E040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x3E040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x3E044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3E044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x3E044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3E044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3E044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3E044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3E044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3E044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3E044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3E04401A Reserved - - Reserved
0x3E04401B Reserved - - Reserved
0x3E044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3E044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3E044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3E044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3E044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3E044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3E044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3E04402A Reserved - - Reserved
0x3E04402B Reserved - - Reserved
0x3E044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3E044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3E044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3E044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3E044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3E044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3E044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3E04403A Reserved - - Reserved
0x3E04403B Reserved - - Reserved
0x3E044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3E044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3E044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3E044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3E044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3E044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3E044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3E04404A Reserved - - Reserved
0x3E04404B Reserved - - Reserved
0x3E044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3E044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3E044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3E044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3E044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3E044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3E044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3E04405A Reserved - - Reserved
0x3E04405B Reserved - - Reserved
0x3E044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3E044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3E044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3E044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3E044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3E044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3E044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3E044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3E044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3E044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3E044FF3 Reserved - - Reserved
0x3E044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3E080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x3E080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3E080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3E08000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3E08000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3E080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3E080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3E080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3E080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3E080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3E080040 Reserved - - Reserved
0x3E080041 Reserved - - Reserved
0x3E080042 Reserved - - Reserved
0x3E080043 Reserved - - Reserved
0x3E080044 Reserved - - Reserved
0x3E080045 Reserved - - Reserved
0x3E080050 Reserved - - Reserved
0x3E080051 Reserved - - Reserved
0x3E080052 Reserved - - Reserved
0x3E080053 Reserved - - Reserved
0x3E080054 Reserved - - Reserved
0x3E080055 Reserved - - Reserved
0x3E080060 Reserved - - Reserved
0x3E080061 Reserved - - Reserved
0x3E080062 Reserved - - Reserved
0x3E080063 Reserved - - Reserved
0x3E080084 Reserved - - Reserved
0x3E080065 Reserved - - Reserved
0x3E080070 Reserved - - Reserved
0x3E080071 Reserved - - Reserved
0x3E080072 Reserved - - Reserved
0x3E080073 Reserved - - Reserved
0x3E080074 Reserved - - Reserved
0x3E080075 Reserved - - Reserved
0x3E080080 Reserved - - Reserved
0x3E080081 Reserved - - Reserved
0x3E080082 Reserved - - Reserved
0x3E080083 Reserved - - Reserved
0x3E080084 Reserved - - Reserved
0x3E080085 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 3) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3E084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x3E084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x3E084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x3E084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3E08400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3E08400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x3E084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x3E084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x3E084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x3E084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x3E084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x3E084016 Reserved - - Reserved
0x3E084017 Reserved - - Reserved
0x3E084040 Reserved - - Reserved
0x3E084041 Reserved - - Reserved
0x3E084042 Reserved - - Reserved
0x3E084043 Reserved - - Reserved
0x3E084044 Reserved - - Reserved
0x3E084045 Reserved - - Reserved
0x3E084046 Reserved - - Reserved
0x3E084047 Reserved - - Reserved
0x3E084050 Reserved - - Reserved
0x3E084051 Reserved - - Reserved
0x3E084052 Reserved - - Reserved
0x3E084053 Reserved - - Reserved
0x3E084054 Reserved - - Reserved
0x3E084055 Reserved - - Reserved
0x3E084056 Reserved - - Reserved
0x3E084057 Reserved - - Reserved
0x3E084060 Reserved - - Reserved
0x3E084061 Reserved - - Reserved
0x3E084062 Reserved - - Reserved
0x3E084063 Reserved - - Reserved
0x3E084074 Reserved - - Reserved
0x3E084065 Reserved - - Reserved
0x3E084066 Reserved - - Reserved
0x3E084067 Reserved - - Reserved
0x3E084070 Reserved - - Reserved
0x3E084071 Reserved - - Reserved
0x3E084072 Reserved - - Reserved
0x3E084073 Reserved - - Reserved
0x3E084074 Reserved - - Reserved
0x3E084075 Reserved - - Reserved
0x3E084076 Reserved - - Reserved
0x3E084077 Reserved - - Reserved
0x3E084080 Reserved - - Reserved
0x3E084081 Reserved - - Reserved
0x3E084082 Reserved - - Reserved
0x3E084083 Reserved - - Reserved
0x3E084084 Reserved - - Reserved
0x3E084085 Reserved - - Reserved
0x3E084086 Reserved - - Reserved
0x3E084087 Reserved - - Reserved
0x3E084090 Reserved - - Reserved
0x3E084091 Reserved - - Reserved
0x3E084092 Reserved - - Reserved
0x3E084093 Reserved - - Reserved
0x3E084094 Reserved - - Reserved
0x3E084095 Reserved - - Reserved
0x3E084096 Reserved - - Reserved
0x3E084097 Reserved - - Reserved
0x3E0840A0 Reserved - - Reserved
0x3E0840A1 Reserved - - Reserved
0x3E0840A2 Reserved - - Reserved
0x3E0840A3 Reserved - - Reserved
0x3E0840A4 Reserved - - Reserved
0x3E0840A5 Reserved - - Reserved
0x3E0840A6 Reserved - - Reserved
0x3E0840A7 Reserved - - Reserved
0x3E0840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x3E0840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x3E0840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x3E0840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x3E0840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x3E0840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x3E0840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x3E0840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x3E0840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x3E0840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x3E0840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x3E0840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x3E0840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x3E0840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x3E0840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x3E0840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x3E0840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x3E0840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x3E0840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x3E0840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x3E0840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x3E0840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x3E0840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x3E0840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x3E0840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x3E0840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x3E0840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x3E0840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x3E0840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x3E0840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x3E0840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x3E0840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x3E0840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x3E0840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x3E0840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x3E0840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x3E0840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x3E0840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x3E0840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x3E084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x3E084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x3E084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x3E084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x3E084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x3E084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x3E084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x3E084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x3E084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x3E084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x3E084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x3E084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x3E084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x3E084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x3E084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x3E084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 1, virtual port 4) : Sub Blocks

[Back to index]
Start Address Description
0x3F000000 Network Interface Parameters for network interface
0x3F00C000 Network Interface Parameters for VLAN
0x3F018000 Network Interface Parameters for IP4
0x3F01C000 Network Interface Parameters for IP4 Statistics
0x3F020000 Network Interface Parameters for IP4 status
0x3F040000 Network Interface Parameters for ARP entry configuration
0x3F044000 Network Interface Parameters for ARP table
0x3F080000 Network Interface Parameters for IP6 address configuration
0x3F084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F00C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x3F00C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x3F00C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x3F00C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3F018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x3F018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3F018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x3F018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x3F018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3F018010 Reserved - - Reserved
0x3F018011 Reserved - - Reserved
0x3F018012 Reserved - - Reserved
0x3F018020 Reserved - - Reserved
0x3F018021 Reserved - - Reserved
0x3F018022 Reserved - - Reserved
0x3F018030 Reserved - - Reserved
0x3F018031 Reserved - - Reserved
0x3F018032 Reserved - - Reserved
0x3F018040 Reserved - - Reserved
0x3F018041 Reserved - - Reserved
0x3F018042 Reserved - - Reserved
0x3F018050 Reserved - - Reserved
0x3F018051 Reserved - - Reserved
0x3F018052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F01C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x3F01C001 Reserved - - Reserved
0x3F01C002 Reserved - - Reserved
0x3F01C003 Reserved - - Reserved
0x3F01C004 Reserved - - Reserved
0x3F01C005 Reserved - - Reserved
0x3F01C006 Reserved - - Reserved
0x3F01C007 Reserved - - Reserved
0x3F01C008 Reserved - - Reserved
0x3F01C009 Reserved - - Reserved
0x3F01C00A Reserved - - Reserved
0x3F01C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x3F01C00C Reserved - - Reserved
0x3F01C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x3F01C00E Reserved - - Reserved
0x3F01C00F Reserved - - Reserved
0x3F01C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x3F01C011 Reserved - - Reserved
0x3F01C012 Reserved - - Reserved
0x3F01C013 Reserved - - Reserved
0x3F01C014 Reserved - - Reserved
0x3F01C015 Reserved - - Reserved
0x3F01C016 Reserved - - Reserved
0x3F01C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x3F01C018 Reserved - - Reserved
0x3F01C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x3F01C01A Reserved - - Reserved
0x3F01C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x3F01C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x3F020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x3F020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x3F020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x3F020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x3F020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x3F020010 Reserved - - Reserved
0x3F020011 Reserved - - Reserved
0x3F020012 Reserved - - Reserved
0x3F020020 Reserved - - Reserved
0x3F020021 Reserved - - Reserved
0x3F020022 Reserved - - Reserved
0x3F020030 Reserved - - Reserved
0x3F020031 Reserved - - Reserved
0x3F020032 Reserved - - Reserved
0x3F020040 Reserved - - Reserved
0x3F020041 Reserved - - Reserved
0x3F020042 Reserved - - Reserved
0x3F020050 Reserved - - Reserved
0x3F020051 Reserved - - Reserved
0x3F020052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x3F040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3F040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x3F040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x3F040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x3F040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x3F040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x3F044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x3F044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x3F044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3F044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3F044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3F044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3F044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3F044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3F044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3F04401A Reserved - - Reserved
0x3F04401B Reserved - - Reserved
0x3F044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3F044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3F044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3F044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3F044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3F044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3F044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3F04402A Reserved - - Reserved
0x3F04402B Reserved - - Reserved
0x3F044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3F044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3F044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3F044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3F044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3F044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3F044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3F04403A Reserved - - Reserved
0x3F04403B Reserved - - Reserved
0x3F044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3F044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3F044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3F044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3F044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3F044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3F044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3F04404A Reserved - - Reserved
0x3F04404B Reserved - - Reserved
0x3F044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3F044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3F044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3F044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3F044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3F044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3F044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3F04405A Reserved - - Reserved
0x3F04405B Reserved - - Reserved
0x3F044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x3F044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x3F044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x3F044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x3F044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x3F044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x3F044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x3F044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x3F044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x3F044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x3F044FF3 Reserved - - Reserved
0x3F044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x3F080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x3F080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3F080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3F08000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3F08000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x3F080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3F080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3F080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3F080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3F080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x3F080040 Reserved - - Reserved
0x3F080041 Reserved - - Reserved
0x3F080042 Reserved - - Reserved
0x3F080043 Reserved - - Reserved
0x3F080044 Reserved - - Reserved
0x3F080045 Reserved - - Reserved
0x3F080050 Reserved - - Reserved
0x3F080051 Reserved - - Reserved
0x3F080052 Reserved - - Reserved
0x3F080053 Reserved - - Reserved
0x3F080054 Reserved - - Reserved
0x3F080055 Reserved - - Reserved
0x3F080060 Reserved - - Reserved
0x3F080061 Reserved - - Reserved
0x3F080062 Reserved - - Reserved
0x3F080063 Reserved - - Reserved
0x3F080084 Reserved - - Reserved
0x3F080065 Reserved - - Reserved
0x3F080070 Reserved - - Reserved
0x3F080071 Reserved - - Reserved
0x3F080072 Reserved - - Reserved
0x3F080073 Reserved - - Reserved
0x3F080074 Reserved - - Reserved
0x3F080075 Reserved - - Reserved
0x3F080080 Reserved - - Reserved
0x3F080081 Reserved - - Reserved
0x3F080082 Reserved - - Reserved
0x3F080083 Reserved - - Reserved
0x3F080084 Reserved - - Reserved
0x3F080085 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 4) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x3F084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x3F084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x3F084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x3F084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x3F08400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x3F08400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x3F084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x3F084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x3F084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x3F084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x3F084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x3F084016 Reserved - - Reserved
0x3F084017 Reserved - - Reserved
0x3F084040 Reserved - - Reserved
0x3F084041 Reserved - - Reserved
0x3F084042 Reserved - - Reserved
0x3F084043 Reserved - - Reserved
0x3F084044 Reserved - - Reserved
0x3F084045 Reserved - - Reserved
0x3F084046 Reserved - - Reserved
0x3F084047 Reserved - - Reserved
0x3F084050 Reserved - - Reserved
0x3F084051 Reserved - - Reserved
0x3F084052 Reserved - - Reserved
0x3F084053 Reserved - - Reserved
0x3F084054 Reserved - - Reserved
0x3F084055 Reserved - - Reserved
0x3F084056 Reserved - - Reserved
0x3F084057 Reserved - - Reserved
0x3F084060 Reserved - - Reserved
0x3F084061 Reserved - - Reserved
0x3F084062 Reserved - - Reserved
0x3F084063 Reserved - - Reserved
0x3F084074 Reserved - - Reserved
0x3F084065 Reserved - - Reserved
0x3F084066 Reserved - - Reserved
0x3F084067 Reserved - - Reserved
0x3F084070 Reserved - - Reserved
0x3F084071 Reserved - - Reserved
0x3F084072 Reserved - - Reserved
0x3F084073 Reserved - - Reserved
0x3F084074 Reserved - - Reserved
0x3F084075 Reserved - - Reserved
0x3F084076 Reserved - - Reserved
0x3F084077 Reserved - - Reserved
0x3F084080 Reserved - - Reserved
0x3F084081 Reserved - - Reserved
0x3F084082 Reserved - - Reserved
0x3F084083 Reserved - - Reserved
0x3F084084 Reserved - - Reserved
0x3F084085 Reserved - - Reserved
0x3F084086 Reserved - - Reserved
0x3F084087 Reserved - - Reserved
0x3F084090 Reserved - - Reserved
0x3F084091 Reserved - - Reserved
0x3F084092 Reserved - - Reserved
0x3F084093 Reserved - - Reserved
0x3F084094 Reserved - - Reserved
0x3F084095 Reserved - - Reserved
0x3F084096 Reserved - - Reserved
0x3F084097 Reserved - - Reserved
0x3F0840A0 Reserved - - Reserved
0x3F0840A1 Reserved - - Reserved
0x3F0840A2 Reserved - - Reserved
0x3F0840A3 Reserved - - Reserved
0x3F0840A4 Reserved - - Reserved
0x3F0840A5 Reserved - - Reserved
0x3F0840A6 Reserved - - Reserved
0x3F0840A7 Reserved - - Reserved
0x3F0840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x3F0840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x3F0840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x3F0840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x3F0840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x3F0840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x3F0840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x3F0840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x3F0840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x3F0840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x3F0840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x3F0840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x3F0840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x3F0840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x3F0840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x3F0840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x3F0840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x3F0840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x3F0840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x3F0840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x3F0840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x3F0840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x3F0840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x3F0840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x3F0840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x3F0840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x3F0840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x3F0840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x3F0840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x3F0840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x3F0840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x3F0840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x3F0840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x3F0840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x3F0840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x3F0840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x3F0840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x3F0840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x3F0840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x3F084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x3F084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x3F084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x3F084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x3F084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x3F084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x3F084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x3F084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x3F084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x3F084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x3F084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x3F084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x3F084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x3F084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x3F084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x3F084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Virtual interface Configuration (physical port 1, virtual port 5) : Sub Blocks

[Back to index]
Start Address Description
0x40000000 Network Interface Parameters for network interface
0x4000C000 Network Interface Parameters for VLAN
0x40018000 Network Interface Parameters for IP4
0x4001C000 Network Interface Parameters for IP4 Statistics
0x40020000 Network Interface Parameters for IP4 status
0x40040000 Network Interface Parameters for ARP entry configuration
0x40044000 Network Interface Parameters for ARP table
0x40080000 Network Interface Parameters for IP6 address configuration
0x40084000 Network Interface Parameters for IP6 address status

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for network interface

[Back to index | Back to parent block]
Address Name RW Default Description
0x40000000 network interface control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = network interface enabled. Valid values:
0 network interface disabled
1 network interface enabled
A virtual port with a virtual port number greater than 0 can only be
configured if the vlan id has been set. Only 6 virtual interfaces can
be configured on a ToPSync. Virtual ports cannot be deconfigured using
the mmapi.

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for VLAN

[Back to index | Back to parent block]
Address Name RW Default Description
0x4000C000 VLAN control register RW 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 disable vlan on this interface
1 enable vlan on this interface
The VLAN configuration can be setup at any time but it is only applied
when the interface is configured. An interface cannot be deconfigured
so vlans cannot be disabled on an interface once they have been enabled.
0x4000C001 VLAN tag register RW 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.
The vlan configuration is applied when the interface is configured. Once
an interface has been configured to use a vlan, a write to this register
will change the vlan tag only if the interface has not been configured
to be used by any other subsystems. For example, the vlan tag cannot be
changed if the interface is configured with an IP address.
0x4000C010 VLAN status control register RO 0 Bits[31:1] = Reserved
Bits[0:0] = VLAN enabled. Valid values:
0 vlan on this interface is disabled
1 vlan on this interface is enabled
0x4000C011 VLAN status tag register RO 0 Bits[31:16] = Reserved
Bits[15:13] = Priority Code Point(PCP). This refers to the IEEE 802.1p
priority. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[12:12] = Drop Eligible Indicator(DEI). This indicates whether a
frame is eligible to be dropped in the presence of
congestion. It sets the value that will be written to the
VLAN header when a frame is transmitted on this interface.
Bits[11:0] = VLAN identifier(VID). This specifies the value of the VID
that the interface belongs to. The interface will send and
receive frames with this VID set in the VLAN header. The
values 0x000 and 0xFFF are reserved.

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for IP4

[Back to index | Back to parent block]
Address Name RW Default Description
0x40018000 IP4 configuration control RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP4 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip4 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the ip4 configuration on the network interface. This will not change the ip4 configuration
registers.
1 configure the network interface with the parameters that have been setup by the ip4 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an ip4 address
and a valid subnet mask. This operation is only permitted when the network interface does not already have an
active ip4 configuration.
2 change ip4 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If ip4 is configured on the network interface, unconfigure the ip4 default gateway using the ip4 address in
the ip4 default gateway configuration register.
4 If ip4 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be the ip4 address in the ip4 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x40018001 IP4 dhcp configuration control RW 1 Bits[31:1] = Reserved
Bit[0] = IP4 dhcp enabled. Valid values:
0 IP4 dhcp disabled
1 IP4 dhcp enabled
A write to this register sets the DHCP control configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. This register cannot be changed when
there are multiple IP4 addresses configured on this interface. IP4 addresses with a multi-home index greater than
zero must be unconfigured before the DHCP configuration can be changed. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
Enabling DHCP will clear the IP4 address and subnet configuration registers.
0x40018002 dhcp requested lease period RW 604800 Bits[31:0] = IP4 dhcp requested lease period
A write to this register sets the requested DHCP lease period configuration register and it will not be applied until
the network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x40018003 IP4 address RW 0 Bits[31:0] = IP4 address to be configured.
A write to this register sets the IP4 address configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 address configuration register can only be set when DHCP is disabled in the DHCP control register.
0x40018004 IP4 subnet mask RW 0 Bits[31:0] = IP4 subnet mask.
A write to this register sets the IP4 subnet mask configuration register and it will not be applied until the network
interface is configured by writing to the IP4 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
The IP4 subnet mask register can only be set when DHCP is disabled in the DHCP control register
0x40018005 IP4 default gateway RW 0 Bits[31:0] = IP4 default gateway
A write to this register sets the IP4 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP4 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x40018010 Reserved - - Reserved
0x40018011 Reserved - - Reserved
0x40018012 Reserved - - Reserved
0x40018020 Reserved - - Reserved
0x40018021 Reserved - - Reserved
0x40018022 Reserved - - Reserved
0x40018030 Reserved - - Reserved
0x40018031 Reserved - - Reserved
0x40018032 Reserved - - Reserved
0x40018040 Reserved - - Reserved
0x40018041 Reserved - - Reserved
0x40018042 Reserved - - Reserved
0x40018050 Reserved - - Reserved
0x40018051 Reserved - - Reserved
0x40018052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for IP4 Statistics

[Back to index | Back to parent block]
Address Name RW Default Description
0x4001C000 received ip4 packets RO 0 Bits[31:0] = Number of received ip4 packets
0x4001C001 Reserved - - Reserved
0x4001C002 Reserved - - Reserved
0x4001C003 Reserved - - Reserved
0x4001C004 Reserved - - Reserved
0x4001C005 Reserved - - Reserved
0x4001C006 Reserved - - Reserved
0x4001C007 Reserved - - Reserved
0x4001C008 Reserved - - Reserved
0x4001C009 Reserved - - Reserved
0x4001C00A Reserved - - Reserved
0x4001C00B received ip4 packets that were discared RO 0 Bits[31:0] = Number of received ip4 packets that were discarded
0x4001C00C Reserved - - Reserved
0x4001C00D transmitted ip4 requests RO 0 Bits[31:0] = Number of transmitted ip4 requests
0x4001C00E Reserved - - Reserved
0x4001C00F Reserved - - Reserved
0x4001C010 transmitted ip4 packets that were discarded RO 0 Bits[31:0] = Number of transmitted ip4 discarded packets that were discarded
0x4001C011 Reserved - - Reserved
0x4001C012 Reserved - - Reserved
0x4001C013 Reserved - - Reserved
0x4001C014 Reserved - - Reserved
0x4001C015 Reserved - - Reserved
0x4001C016 Reserved - - Reserved
0x4001C017 received ip4 multicast packets RO 0 Bits[31:0] = Number of received ip4 multicast packets
0x4001C018 Reserved - - Reserved
0x4001C019 transmitted ip4 multicast packets RO 0 Bits[31:0] = Number of transmitted ip4 multicast packets
0x4001C01A Reserved - - Reserved
0x4001C01B received ip4 broadcast packets RO 0 Bits[31:0] = Number of received ip4 broadcast packets
0x4001C01C transmitted ip4 broadcast packets RO 0 Bits[31:0] = Number of transmitted ip4 broadcast packets

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for IP4 status

[Back to index | Back to parent block]
Address Name RW Default Description
0x40020000 IP4 address configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = ip4 enabled. Valid values:
0 ip4 disabled
1 ip4 enabled
0x40020001 IP4 DHCP configuration status RO 0 Bits[31:1] = Reserved
Bit[0] = IP4 DHCP enabled. Valid values:
0 IP4 DHCP disabled
1 IP4 DHCP enabled
0x40020002 DHCP requested lease period RO 0 Bits[31:0] = IP4 DHCP lease period
0x40020003 IP4 address RO 0 Bits[31:0] = IP4 address
0x40020004 IP4 subnet mask RO 0 Bits[31:0] = IP4 subnet mask
0x40020005 IP4 default gateway RO 0 Bits[31:0] = IP4 default gateway
0x40020010 Reserved - - Reserved
0x40020011 Reserved - - Reserved
0x40020012 Reserved - - Reserved
0x40020020 Reserved - - Reserved
0x40020021 Reserved - - Reserved
0x40020022 Reserved - - Reserved
0x40020030 Reserved - - Reserved
0x40020031 Reserved - - Reserved
0x40020032 Reserved - - Reserved
0x40020040 Reserved - - Reserved
0x40020041 Reserved - - Reserved
0x40020042 Reserved - - Reserved
0x40020050 Reserved - - Reserved
0x40020051 Reserved - - Reserved
0x40020052 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for ARP entry configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x40040000 network interface arp entry control register RW 0 Bits[31:2] = Reserve
Bits[2:0] = Writing to this register will cause an add, delete or get operation to be performed. Each
of these operations require that the appropriate ARP entry registers have been setup and the operation
may also setup any appropriate ARP entry registers. A read will always return 0. Valid values:
1 - Add an ARP entry for the IP and Ethernet address set in the ARP entry registers
2 - Delete the ARP entry associated with the IP address set in the ARP entry registers
3 - Delete the ARP entry associated with the Ethernet address set in the ARP entry registers
4 - Get the ARP entry Ethernet address associated with the IP address set in ARP entry registers
5 - Get the ARP entry IP address associated with the Ethernet address set in the ARP entry registers
0x40040001 address family RW 0 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x40040002 IP address length RW 4 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40040003 IP address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40040004 IP address bytes 4..7 RW 0 Bits[31:0] = Reserved
0x40040005 IP address bytes 8..11 RW 0 Bits[31:0] = Reserved
0x40040006 IP address bytes 12..15 RW 0 Bits[31:0] = Reserved
0x40040007 Ethernet address length RO 6 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40040008 Ethernet address bytes 0..3 RW 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
0x40040009 Ethernet address bytes 4..7 RW 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for ARP table

[Back to index | Back to parent block]
Address Name RW Default Description
0x40044000 network interface arp table control register RW 0 Bits[31:8] = Reserve
Bits[7:0] = Writing to this register will cause the arp table entries for this interface to be read
and will be accessible via the appropriate arp table registers. A read will always return 0. Valid values:
1 - Read the ARP table entries
0x40044001 address family of entries to be read from ARP table RW 1 Bits[31:8] = Reserved
Bits[7:0] = Address family. Valid values:
1 - IPv4
0x40044002 number of entries read from the ARP table RO 0 Bits[31:8] = Reserved
Bits[7:0] = Number of entries read from the ARP table
0x40044010 ARP entry 1 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x40044011 ARP entry 1 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40044012 ARP entry 1 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40044013 ARP entry 1 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x40044014 ARP entry 1 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x40044015 ARP entry 1 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x40044016 ARP entry 1 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40044017 ARP entry 1 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x40044018 ARP entry 1 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x40044019 ARP entry 1 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x4004401A Reserved - - Reserved
0x4004401B Reserved - - Reserved
0x40044020 ARP entry 2 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x40044021 ARP entry 2 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40044022 ARP entry 2 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40044023 ARP entry 2 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x40044024 ARP entry 2 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x40044025 ARP entry 2 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x40044026 ARP entry 2 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40044027 ARP entry 2 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x40044028 ARP entry 2 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x40044029 ARP entry 2 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x4004402A Reserved - - Reserved
0x4004402B Reserved - - Reserved
0x40044030 ARP entry 3 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x40044031 ARP entry 3 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40044032 ARP entry 3 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40044033 ARP entry 3 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x40044034 ARP entry 3 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x40044035 ARP entry 3 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x40044036 ARP entry 3 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40044037 ARP entry 3 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x40044038 ARP entry 3 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x40044039 ARP entry 3 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x4004403A Reserved - - Reserved
0x4004403B Reserved - - Reserved
0x40044040 ARP entry 4 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x40044041 ARP entry 4 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40044042 ARP entry 4 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40044043 ARP entry 4 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x40044044 ARP entry 4 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x40044045 ARP entry 4 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x40044046 ARP entry 4 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40044047 ARP entry 4 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x40044048 ARP entry 4 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x40044049 ARP entry 4 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x4004404A Reserved - - Reserved
0x4004404B Reserved - - Reserved
0x40044050 ARP entry 5 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x40044051 ARP entry 5 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40044052 ARP entry 5 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40044053 ARP entry 5 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x40044054 ARP entry 5 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x40044055 ARP entry 5 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x40044056 ARP entry 5 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40044057 ARP entry 5 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x40044058 ARP entry 5 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x40044059 ARP entry 5 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x4004405A Reserved - - Reserved
0x4004405B Reserved - - Reserved
0x40044FE0 ARP entry 254 address family RO 0 Bits[31:8] = Reserved
Bits[7:0] = address family. Valid values:
1 - IPv4
0x40044FE1 ARP entry 254 IP address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of IP address
0x40044FE2 ARP entry 254 IP address bytes 0..3 RO 0 Bits[31:0] = The first 4 bytes of the IP address.
For an IP4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
0x40044FE3 ARP entry 254 IP address bytes 4..7 RO 0 Bits[31:0] = Reserved
0x40044FE4 ARP entry 254 IP address bytes 8..11 RO 0 Bits[31:0] = Reserved
0x40044FE5 ARP entry 254 IP address bytes 12..15 RO 0 Bits[31:0] = Reserved
0x40044FE6 ARP entry 254 Ethernet address length RO 0 Bits[31:8] = Reserved
Bits[7:0] = Length of physical address
0x40044FF0 ARP entry 254 Ethernet address bytes 0..3 RO 0 Bits[31:24] = MAC address byte 0 (Most significant byte of 6-byte MAC address )
Bits[23:16] = MAC address byte 1
Bits[15:8] = MAC address byte 2
Bits[7:0] = MAC address byte 3
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 0 = 0x00, byte 1 = 0x16, byte 2 = 0xC0, byte 3 = 0x1F
A read of this register, will return the physical address that was set in the ARP IP address registers.
A write to this register will not take effect until the appropriate control bit is written.
0x40044FF1 ARP entry 254 Ethernet address bytes 4..7 RO 0 Bits[31:24] = MAC address byte 4
Bits[23:16] = MAC address byte 5 (Least significant byte of 6-byte MAC address )
Bit[15:0] = Reserved
e.g. MAC Address 00:16:C0:1F:B1:01 Byte 4 = 0xB1, byte 5 = 0x01
0x40044FF2 ARP entry 254 ARP entry time-to-live RO 0 Bits[31:0] = time to live for ARP entry
0x40044FF3 Reserved - - Reserved
0x40044FF4 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for IP6 address configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0x40080000 IP6 address multi-home index 0 configuration control RW 1 Bits[31:1] = Reserved
Bit[2:0] = IP6 address multi-home index 0 configuration control.
A write to this register initiates one of the operations described below. A read will return whether ip6 has
been configured or unconfigured. It does not indicate whether the operation was successful and the appropriate
status register should be read to determine this. Valid values:
0 unconfigure the IP6 configuration on the network interface. This will not change the IP6 configuration
registers.
1 configure the network interface with the parameters that have been setup by the IP6 configuration registers.
The configuration registers should have been setup with a valid configuration, for example an IP6 address
and a valid prefix length. This operation is only permitted when the network interface does not already have an
active IP6 configuration.
2 change IP6 address. This is an unconfigure operation followed by a configure operation in a single API call.
3 If IP6 is configured on the network interface, unconfigure the IP6 default gateway using the IP6 address in
the IP6 default gateway configuration register.
4 If IP6 is configured on the network interface and a default gateway is not configured, configure a default
gateway to be IP6 address in the IP6 default gateway configuration register.
A ToPSync should not be configured with more than 6 IP addresses.
0x40080001 IP6 address allocation mechanism RW 1 Bits[31:3] = Reserved
Bit[2:0] = IP6 address allocation mechanism. Valid values:
1 Static
4 Stateless address autoconfiguration
A write to this register sets the IP6 address allocation mechanism and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. Stateless address autoconfiguration
cannot be enabled when there are multiple IP6 addresses statically configured on the interface. Static IPv6 addresses
with a multi-home index greater than zero must be unconfigured before stateless address autoconfiguration can be
configured. A read will read this register and it may not be the same as the configuration currently setup on the
network interface. The current configuration on the network interface can be read using the appropriate status register.
Enabling stateless address autoconfiguration will clear the IP6 address and subnet configuration registers.
0x40080008 IP6 default gateway bytes 0..3 RW 0 Bits[31:0] = IP6 default gateway bytes 0 to 3.
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x40080009 IP6 default gateway bytes 4..7 RW 0 Bits[31:0] = IP6 default gateway bytes 4 to 7
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x4008000A IP6 default gateway bytes 8..11 RW 0 Bits[31:0] = IP6 default gateway bytes 8 to 11
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x4008000B IP6 default gateway bytes 12..15 RW 0 Bits[31:0] = IP6 default gateway bytes 12 to 15
A write to this register sets the IP6 default gateway configuration register and it will not be applied until the
network interface is configured by writing to the IP6 configuration control register. A read will read this register
and it may not be the same as the configuration currently setup on the network interface. The current configuration
on the network interface can be read using the appropriate status register.
0x40080010 IP6 address multi-home index 0 bytes 0..3 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x40080011 IP6 address multi-home index 0 bytes 4 ..7 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x40080012 IP6 address multi-home index 0 bytes 8 to 11 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x40080013 IP6 address multi-home index 0 bytes 12 to 15 RW 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15.
A write to this register sets the IP6 address configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x40080014 IP6 address multi-home index 0 prefix length RW 0 Bits[31:0] = IP6 address multi-home index 0 prefix length
A write to this register sets the IP6 prefix length configuration register and it will not be applied until the network
interface is configured by writing to the IP6 configuration control register. A read will read this register and it
may not be the same as the configuration currently setup on the network interface. The current configuration on the
network interface can be read using the appropriate status register.
0x40080040 Reserved - - Reserved
0x40080041 Reserved - - Reserved
0x40080042 Reserved - - Reserved
0x40080043 Reserved - - Reserved
0x40080044 Reserved - - Reserved
0x40080045 Reserved - - Reserved
0x40080050 Reserved - - Reserved
0x40080051 Reserved - - Reserved
0x40080052 Reserved - - Reserved
0x40080053 Reserved - - Reserved
0x40080054 Reserved - - Reserved
0x40080055 Reserved - - Reserved
0x40080060 Reserved - - Reserved
0x40080061 Reserved - - Reserved
0x40080062 Reserved - - Reserved
0x40080063 Reserved - - Reserved
0x40080084 Reserved - - Reserved
0x40080065 Reserved - - Reserved
0x40080070 Reserved - - Reserved
0x40080071 Reserved - - Reserved
0x40080072 Reserved - - Reserved
0x40080073 Reserved - - Reserved
0x40080074 Reserved - - Reserved
0x40080075 Reserved - - Reserved
0x40080080 Reserved - - Reserved
0x40080081 Reserved - - Reserved
0x40080082 Reserved - - Reserved
0x40080083 Reserved - - Reserved
0x40080084 Reserved - - Reserved
0x40080085 Reserved - - Reserved

Virtual interface Configuration (physical port 1, virtual port 5) : Network Interface Parameters for IP6 address status

[Back to index | Back to parent block]
Address Name RW Default Description
0x40084000 IP6 address multi-home index 0 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 0 disabled
1 IP6 address multi-home index 0 enabled
0x40084001 IP6 address allocation mechanism status RO 0 Bits[31:2] = Reserved
Bit[2:0] = IP6 address allocation mechanism status. Valid values:
1 Static
4 Stateless address autoconfiguration
0x40084008 IP6 default gateway bytes 0..3 status RO 0 Bits[31:0] = IP6 default gateway bytes 0 to 3 status
0x40084009 IP6 default gateway bytes 4..7 status RO 0 Bits[31:0] = IP6 default gateway bytes 4 to 8 status
0x4008400A IP6 default gateway bytes 8..11 status RO 0 Bits[31:0] = IP6 default gateway bytes 8 to 11 status
0x4008400B IP6 default gateway bytes 12..15 status RO 0 Bits[31:0] = IP6 default gateway bytes 12 to 15 status
0x40084011 IP6 address multi-home index 0 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 0 to 3 status
0x40084012 IP6 address multi-home index 0 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 4 to 7 status
0x40084013 IP6 address multi-home index 0 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 8 to 11 status
0x40084014 IP6 address multi-home index 0 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 0 bytes 12 to 15 status
0x40084015 IP6 address multi-home index 0 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 0 prefix length status
0x40084016 Reserved - - Reserved
0x40084017 Reserved - - Reserved
0x40084040 Reserved - - Reserved
0x40084041 Reserved - - Reserved
0x40084042 Reserved - - Reserved
0x40084043 Reserved - - Reserved
0x40084044 Reserved - - Reserved
0x40084045 Reserved - - Reserved
0x40084046 Reserved - - Reserved
0x40084047 Reserved - - Reserved
0x40084050 Reserved - - Reserved
0x40084051 Reserved - - Reserved
0x40084052 Reserved - - Reserved
0x40084053 Reserved - - Reserved
0x40084054 Reserved - - Reserved
0x40084055 Reserved - - Reserved
0x40084056 Reserved - - Reserved
0x40084057 Reserved - - Reserved
0x40084060 Reserved - - Reserved
0x40084061 Reserved - - Reserved
0x40084062 Reserved - - Reserved
0x40084063 Reserved - - Reserved
0x40084074 Reserved - - Reserved
0x40084065 Reserved - - Reserved
0x40084066 Reserved - - Reserved
0x40084067 Reserved - - Reserved
0x40084070 Reserved - - Reserved
0x40084071 Reserved - - Reserved
0x40084072 Reserved - - Reserved
0x40084073 Reserved - - Reserved
0x40084074 Reserved - - Reserved
0x40084075 Reserved - - Reserved
0x40084076 Reserved - - Reserved
0x40084077 Reserved - - Reserved
0x40084080 Reserved - - Reserved
0x40084081 Reserved - - Reserved
0x40084082 Reserved - - Reserved
0x40084083 Reserved - - Reserved
0x40084084 Reserved - - Reserved
0x40084085 Reserved - - Reserved
0x40084086 Reserved - - Reserved
0x40084087 Reserved - - Reserved
0x40084090 Reserved - - Reserved
0x40084091 Reserved - - Reserved
0x40084092 Reserved - - Reserved
0x40084093 Reserved - - Reserved
0x40084094 Reserved - - Reserved
0x40084095 Reserved - - Reserved
0x40084096 Reserved - - Reserved
0x40084097 Reserved - - Reserved
0x400840A0 Reserved - - Reserved
0x400840A1 Reserved - - Reserved
0x400840A2 Reserved - - Reserved
0x400840A3 Reserved - - Reserved
0x400840A4 Reserved - - Reserved
0x400840A5 Reserved - - Reserved
0x400840A6 Reserved - - Reserved
0x400840A7 Reserved - - Reserved
0x400840B1 IP6 address multi-home index 8 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 0 to 3 status
0x400840B2 IP6 address multi-home index 8 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 4 to 7 status
0x400840B3 IP6 address multi-home index 8 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 8 to 11 status
0x400840B4 IP6 address multi-home index 8 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 8 bytes 12 to 15 status
0x400840B5 IP6 address multi-home index 8 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 8 prefix length status
0x400840B6 IP6 address multi-home index 8 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 valid lifetime status
0x400840B7 IP6 address multi-home index 8 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 8 preferred lifetime status
0x400840C0 IP6 address multi-home index 9 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 9 disabled
1 IP6 address multi-home index 9 enabled
0x400840C1 IP6 address multi-home index 9 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 0 to 3 status
0x400840C2 IP6 address multi-home index 9 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 4 to 7 status
0x400840C3 IP6 address multi-home index 9 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 8 to 11 status
0x400840C4 IP6 address multi-home index 9 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 9 bytes 12 to 15 status
0x400840C5 IP6 address multi-home index 9 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 9 prefix length status
0x400840C6 IP6 address multi-home index 9 valid lifetime status RO 0 Bits[31:0] = IP6 multi-home index valid lifetime status
0x400840C7 IP6 address multi-home index 9 preferred lifetime status RO 0 Bits[31:0] = IP6 multihome index 9 preferred lifetime status
0x400840D0 IP6 address multi-home index 10 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 10 disabled
1 IP6 address multi-home index 10 enabled
0x400840D1 IP6 address multi-home index 10 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 0 to 3 status
0x400840D2 IP6 address multi-home index 10 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 4 to 7 status
0x400840D3 IP6 address multi-home index 10 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 8 to 11 status
0x400840D4 IP6 address multi-home index 10 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 10 bytes 12 to 15 status
0x400840D5 IP6 address multi-home index 10 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 10 prefix length status
0x400840D6 IP6 address multi-home index 10 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 valid lifetime status
0x400840D7 IP6 address multi-home index 10 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 10 preferred lifetime status
0x400840E0 IP6 address multi-home index 11 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 11 disabled
1 IP6 address multi-home index 11 enabled
0x400840E1 IP6 address multi-home index 11 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 0 to 3 status
0x400840E2 IP6 address multi-home index 11 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 11 bytes 4 to 7 status
0x400840E3 IP6 address multi-home index 11 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 8 to 11 status
0x400840E4 IP6 address multi-home index 11 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index bytes 12 to 15 status
0x400840E5 IP6 address multi-home index 11 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 11 prefix length status
0x400840E6 IP6 address multi-home index 11 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 valid lifetime status
0x400840E7 IP6 address multi-home index 11 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 11 preferred lifetime status
0x400840F0 IP6 address multi-home index 12 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 12 disabled
1 IP6 address multi-home index 12 enabled
0x400840F1 IP6 address multi-home index 12 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 0 to 3 status
0x400840F2 IP6 address multi-home index 12 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 4 to 7 status
0x400840F3 IP6 address multi-home index 12 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index index 12 bytes 8 to 11 status
0x400840F4 IP6 address multi-home index 12 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 12 bytes 12 to 15 status
0x400840F5 IP6 address multi-home index 12 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 12 prefix length status
0x400840F6 IP6 address multi-home index 12 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 valid lifetime status
0x400840F7 IP6 address multi-home index 12 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 12 preferred lifetime status
0x40084100 IP6 address multi-home index 13 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 13 disabled
1 IP6 address multi-home index 13 enabled
0x40084101 IP6 address multi-home index 13 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 0 to 3 status
0x40084102 IP6 address multi-home index 13 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 4 to 7 status
0x40084103 IP6 address multi-home index 13 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 8 to 11 status
0x40084104 IP6 address multi-home index 13 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 13 bytes 12 to 15 status
0x40084105 IP6 address multi-home index 13 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 13 prefix length status
0x40084106 IP6 address multi-home index 13 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 valid lifetime status
0x40084107 IP6 address multi-home index 13 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 13 preferred lifetime status
0x40084110 IP6 address multi-home index 14 control status RO 0 Bits[31:1] = Reserved
Bit[0] = IP6 enabled status. Valid values:
0 IP6 address multi-home index 14 disabled
1 IP6 address multi-home index 14 enabled
0x40084111 IP6 address multi-home index 14 bytes 0..3 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 0 to 3 status
0x40084112 IP6 address multi-home index 14 bytes 4..7 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 4 to 7 status
0x40084113 IP6 address multi-home index 14 bytes 8 to 11 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 8 to 11 status
0x40084114 IP6 address multi-home index 14 bytes 12 to 15 status RO 0 Bits[31:0] = IP6 address multi-home index 14 bytes 12 to 15 status
0x40084115 IP6 address multi-home index 14 prefix length status RO 0 Bits[31:0] = IP6 address multi-home index 14 prefix length status
0x40084116 IP6 address multi-home index 14 valid lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 valid lifetime status
0x40084117 IP6 address multi-home index 14 preferred lifetime status RO 0 Bits[31:0] = IP6 address multi-home index 14 preferred lifetime status

Image upload control : Sub Blocks

[Back to index]
Start Address Description
0xD0000000 Upload Status
0xD0004000 Upload Configuration
0xD0008000 Upload Data

Image upload control : Upload Status

[Back to index | Back to parent block]
Address Name RW Default Description
0xD0000000 State of image upload process RO 0 Bits[31:3] reserved
Bits[2:0] State. Valid values:
0 Idle. There is no command in progress
1 Active. A command is in progress
2 Error. The command has failed. See error code for details
0xD0000001 Image upload error code RO 0 Bits[31:8] reserved
Bits[7:0] Error code. Valid values:
0 None. No error
1 Timeout. Command timed out
2 CRC Failure. Verify/program command failed on CRC check
3 Incompatible. Image upload is incompatible with this device.
4 Disabled. Image upload is disabled in this device.

Image upload control : Upload Configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0xD0004000 Size of image upload RW 0 Bits[31:0] Image size in bytes
0xD0004001 Image upload CRC RW 0 Bits[31:0] CRC value
0xD0004002 Protocol used for upload RW 0 Bits[31:8] reserved
Bits[7:0] Protocol
0 MMAPI: Image is loaded via MMAPI registers over SPI or network
1 TFTP over IPv4 via network interface
0xD0004003 Security key for upload first word RW 0 Bits[31:0] Key bits 63:32
0xD0004004 Security key for upload second word RW 0 Bits[31:0] Key bits 31:0
0xD0004005 Transmission protocol address bytes 0..3 RW 0 Bits[31:0] = The first 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, the MSB in the word will be 10, the LSB in the word will be 9.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x0, the LSB in the word will be 0x11.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 1, the LSB in the word will be 4.
0xD0004006 Transmission protocol address bytes 4..7 RW 0 Bits[31:0] = The second set of 4 bytes of the address.
Notes: Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:11:00:01, the MSB in the word will be 0x00, the next byte is 0x01.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 5, the LSB in the word will be 8.
0xD0004007 Transmission protocol address bytes 8..11 RW 0 Bits[31:0] = The third set of 4 bytes of the address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 9, the LSB in the word will be 12.
0xD0004008 Transmission protocol address bytes 12..15 RW 0 Bits[31:0] = The fourth set of 4 bytes of the address.
Each byte in this uint32 will be a value in the address. eg
In the udp4 address 10.0.0.9, this word is not used.
In the ethernet address 00:16:c0:ff:fe:11:00:01, this word is not used.
In the udp6 address 1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16, the MSB in the word will be 13, the LSB in the word will be 16.
0xD0004009 Transmission protocol port number RW 0 Bits[31:16] = reserved
Bits[15:0] = Port number
Notes: The port number can have different meaning for different upload protocols
e.g. upd port number or ethertype
0xD000400A Data upload block size RW 39 Bits[31:0] Block size in 32bit words. Range 1-1024
Notes: This register only applies to image upload via MMAPI. Other protocols define their own block size.
0xD000400B Reserved - - Reserved
0xD0004010 Enable image upload operation RW 0 Bits[31:1] = reserved
Bit[0] = enable
The image upload operation can only be enabled/disabled in Initialising System State. See register 0x01000005
0xD0004020 Image upload action RW 0 Bits[31:8] reserved
Bits[7:0] Initiates an action of the upload process:
0 - Start. For network protocols this will start the image upload
For MMAPI protocol the bytes will be transferred via API
1 - Verify image using supplied CRC value
2 - Decrypt image data using specified security protocol
3 - Program image to flash
The state register should be checked to see if the action has completed.
0xD0004040 Image upload filename RW 0 Bits[31:0] = First 4 characters (e.g. 'uplo' if Software Version = 'upload_data.bin')
Notes: Characters are taken from word in Network byte order
Filename must include null termination character
0xD0004041 Image upload filename RW 0 Bits[31:0] = Characters 5 to 8 (e.g. 'ad_d' if Software Version = 'upload_data.bin')
0xD0004042 Image upload filename RW 0 Bits[31:0] = Characters 9 to 12
0xD0004043 Image upload filename RW 0 Bits[31:0] = Characters 13 to 16
0xD0004044 Image upload filename RW 0 Bits[31:0] = Characters 17 to 20
0xD0004045 Image upload filename RW 0 Bits[31:0] = Characters 21 to 24
0xD0004046 Image upload filename RW 0 Bits[31:0] = Characters 25 to 28
0xD0004047 Image upload filename RW 0 Bits[31:0] = Characters 29 to 32

Image upload control : Upload Data

[Back to index | Back to parent block]
Address Name RW Default Description
0xD0008000 Data upload block number RW 0 Bits[31:0] Block number (index starts at zero)
Notes: The block number must be set before any data registers are written
Writes to this register will have no effect unless image upload state is Active
and the upload protocol is MMAPI
0xD0008001 Data upload first data word RW - Bits[31:0] Data word
Notes: The consecutive registers following this one contain the rest of the data block
Writes to this register will have no effect unless image upload state is Active
and the upload protocol is MMAPI. Not the words from the image must be in
Network Byte order (Big Endian)

ACS 1790 Configuration : Sub Blocks

[Back to index]
Start Address Description
0xE0000000 Set system level ASC1790 configuration
0xE0004000 Configure the master ACS1790 device
0xE0008000 Configure the slave ACS1790 device

ACS 1790 Configuration : Set system level ASC1790 configuration

[Back to index | Back to parent block]
Address Name RW Default Description
0xE0000000 Read number of ACS1790 devices discovered RO system-dependent Bits[31:2] Reserved
Bits[1:0] Returns the number of devices found. Valid decimal values:
0 - no devices found
1 - only the master ACS1790 device has been found
2 - both the master and slave ACS1790 devices have been found

Notes: Register is read only and returns the number of ACS1790 devices detected in the system, starting from the lowest I2C address – the master device. If there is no device at this address, the slave will not be located whether it exists in hardware or not.
0xE0000001 Reserved - - Reserved
0xE0000002 Select closed or open loop mode of operation RW 0 Bits [31] Enable closed loop mode?
0 - Open loop mode is active. Note, Acs1790 operation then also depends on bit 30.
1 - Closed loop mode is active
Bits [30] Open loop specific mode.
0 - Tuned oscillator mode
1 - Shared oscillator mode
Bits [29:24] Reserved
Bits [23:16] Only applies for closed loop and shared oscillator modes. Valid bit (decimal) values:
000 (0) Clock PLL 1
001 (1) Clock PLL 2
010 (2) PTP PLL 1
011 (3) PTP PLL 2
100 (4) NODE PLL 1
101 (5) NODE PLL 2
Bits [15:8] The Clock PLL to be used. Valid values are:
0 – Clock PLL 1 used
1 – Clock PLL 2 used
0xff - unconfigured
Bits [7:0] The input clock line that the ACS1790 feedback clock is connected to. Ignored if bit 31 is zero.
0xff - unconfigured

Notes: If bit 31 is set high, this will configure ToPSync ready to use the specified feedback clock. The software
control of the 1790 will start immediately. If bit 31 is set low then the 1790 will run in open loop mode.

Open loop mode: Comes in two flavours, "tuned oscillator mode" and "shared oscillator mode".

Tuned oscillator mode can be used when ToPSync is disciplining an on-board voltage-controlled oscillator that is shared between ToPSync and the 1790 device(s).

If ToPSync is does not disciplining an external oscillator and is, instead, disciplining its own internal NCOs (normal operation) the ACS1790 can still operate in an open loop mode where the frequency offsets applied to the PLL or node time being followed, are applied to the 1790 without feedback. This is shared oscillator mode.

Closed loop mode: When bit 31 is set high this function does two things: firstly it puts the ACS1790 software into closed loop mode and secondly it informs ToPSync of which clock input pin should be monitored for the feedback clock. It will also try to obtain the specified clock time stamping resource, which means that once the 1790 is running closed loop, that clock PLL is not useable by the ToPSync application.
0xE0000003 Reserved - - Reserved
0xE0000004 Reserved - - Reserved
0xE0000005 Reserved - - Reserved
0xE0000006 swap the master and slave addresses over RW 0 Bits[31:1] Reserved
Bits[0:0] Swap master and slave addresses
0 - master is at address 0x60 and slave is at address 0x61
1 - master is at address 0x61 and slave is at address 0x60
Notes: Writing to this will totally reinitialise the 1790 by reading from the addresses chosen and thus all settings will be overwritten.
So after calling this register the user will need to reset the operating mode, dividers, frequencies etc
0xE0000007 write the seconds since epoch mod 1001 over i2c RW 0 Bits[31:1] Reserved
Bits[0:0] This will write the msb and lsb of offset since epoch mod 1001 to the fpga every second
0 - i2c write is disabled
1 - i2c write is enabled
0xE0000008 config value used in calculating offset RW 0 Bits[9:0] = Nab secs since epoch config value
The default value of 0 will cause the secs since epoch to be calculated immediately and written over i2c
Otherwise values from 1 to 1001 will be used as the nab offset and written over i2c

ACS 1790 Configuration : Configure the master ACS1790 device

[Back to index | Back to parent block]
Address Name RW Default Description
0xE0004000 Specify which outputs to use RW system-dependent Bits [31:0] Valid values:
0x0 - Both OUT1 and OUT2 are disabled and held low
0x1 - Only OUT1 is active and will operate at the frequency specified in the frequency register.
0x2 - Only OUT2 is active and will operate at the frequency specified in the frequency register.
0x3 - OUT1 and OUT2 are active and configured to support gigabit Ethernet. Sets OUT1 frequency to 125MHz and OUT2 frequency to 25MHz.
0x4 - OUT1 and OUT2 are active and configured to support 10-gigabit Ethernet. Sets OUT1 frequency to 156.25MHz and OUT2 frequency to 25MHz.

Notes: Used to specify how the ACS1790 OUT1 and OUT2 outputs are used. They can be used in a mutually exclusive way to generate a single output frequency or together to support gigabit and 10-gigabit.

Notes: Calls to this function will reset the ACS1790 and all associated control loops. The information from registers 0xE0004002 and 0xE0004004 is applied.
0xE0004001 Reserved - - Reserved
0xE0004002 Frequency in Hertz to output on selected output RW 0 Bits [31:0] Output frequency in Hertz

Notes: Sets the output frequency of the output selected in 0xE0004000 if one of OUT1 or OUT2 has been chosen as a single output. If either Ethernet modes has been selected then this register is ignored and does nothing on a write and reads back as zero.

Notes: Setting this register will cause the ACS1790 output frequency to jump immediately if the device has already been configured. If not, the changes will be applied when 0xE0004000 is written.
0xE0004003 Reserved - - Reserved
0xE0004004 Configure OUT2 drive strength and slew rate RW 0 Bits [31:2] Reserved
Bit [1] Valid bit values are:
0 the OUT2 CMOS clock output will operate at the 1.8V LVCMOS standard.
1 the OUT2 CMOS clock output will operate at either the 2.5V or 3.3V LVCMOS standard.
Bit [0] 0 the OUT2 signal is driven with slow rise and fall times.
1 the OUT2 signal is driven with fast rise and fall times.

Notes: The OUT2 CMOS clock output can operate at either 1.8V or 2.5V or 3.3V. The signal can be driven with “fast” or “slow” rise and fall times. Refer to the ACS1790 for further clarification. Effect of write is immediate.

Notes: Setting this register will cause the OUT2 settings to be applied immediately if the device has already been configured. If not, the changes will be applied when 0xE0004000 is written.

Notes: If the 1790 device is not present then data returned will not be valid.
0xE0004005 Read 1790 status register RO As per 1790 data sheet Register definition is as per the 1790 data sheet...
Bits[31:7] Reserved
Bit[6] Mode
Bit[5] Oscfsel1
Bit[4] Oscfsel0
Bit[3] a0
Bit[2] a1
Bit[1] oeb
Bit[0] lock
0xE0004006 Get/Set auto-squelch behaviour RW 0 Bits[31:2] Reserved
Bit[1] FBCLK auto squelch. '1' implies auto squelch is enabled. '0' implies disabled.
Bit[0] OUT1 and OUT2 auto squelch. '1' implies auto squelch is enabled. '0' implies disabled.

Warning: The auto-squelch behaviour is disabled by default. It is safe to override the OUT1 and OUT2 auto-squelch behaviour, however FBCLK must not be overriden when using closed loop mode.

Notes: If the 1790 device is not present then data returned will not be valid.
0xE0004007 Reserved - - Reserved
0xE0004008 Reserved - - Reserved
0xE0004009 Reserved - - Reserved
0xE000400A Reserved - - Reserved
0xE000400B Reserved - - Reserved
0xE000400C Reserved - - Reserved
0xE000400D Reserved - - Reserved
0xE000400E Reserved - - Reserved
0xE000400F Reserved - - Reserved
0xE0004010 Reserved - - Reserved
0xE0004011 Reserved - - Reserved
0xE0004012 Reserved - - Reserved
0xE0004013 Reserved - - Reserved
0xE0004014 Reserved - - Reserved
0xE0004015 Reserved - - Reserved
0xE0004016 tDivFrequency RW 0 Bits[31:0] if this is non zero then this frequency is used as the tDiv Frequency instead of any calculations
0xE0004020 the vco freq to be used when enabled thus overriding any calculations RW 0 Bits[31:0] frequency
This is used when register 0xE0004024 is subsequently enabled
0xE0004021 contains the O divider value to be used when enabled thus overriding any calculations RW 0 Bits[31:0] O div value
This is used when register 0xE0004024 is subsequently enabled
0xE0004022 contains the B/P divider value to be used when enabled thus overriding any calculations RW 0 Bits[31:0] B div value
This is used when register 0xE0004024 is subsequently enabled
0xE0004023 scaling factor to be used when disciplining slave when using the overrides RW 0 Bits[31:0] float value.
This is only used when 0xE0004024 is enabled and this value is non zero.
To discipline the slave then this value should be set on the master.
0xE0004024 enables the VCO and divider overrides above RW 0 Bits[31:1] reserved
Bits[0] when this register is written to with a '1' value then the overrides above are enabled and used.

ACS 1790 Configuration : Configure the slave ACS1790 device

[Back to index | Back to parent block]
Address Name RW Default Description
0xE0008000 Specify which outputs to use RW system-dependent Bits [31:0] Valid values:
0x0 - Both OUT1 and OUT2 are disabled and held low
0x1 - Only OUT1 is active and will operate at the frequency specified in the frequency register.
0x2 - Only OUT2 is active and will operate at the frequency specified in the frequency register.
0x3 - OUT1 and OUT2 are active and configured to support gigabit Ethernet. Sets OUT1 frequency to 125MHz and OUT2 frequency to 25MHz.
0x4 - OUT1 and OUT2 are active and configured to support 10-gigabit Ethernet. Sets OUT1 frequency to 156.25MHz and OUT2 frequency to 25MHz.

Notes: Used to specify how the ACS1790 OUT1 and OUT2 outputs are used. They can be used in a mutually exclusive way to generate a single output frequency or together to support gigabit and 10-gigabit.

Notes: Calls to this function will reset the ACS1790 and all associated control loops. The information from registers 0xE0008002 and 0xE0008004 is applied.
0xE0008001 Reserved - - Reserved
0xE0008002 Frequency in Hertz to output on selected output RW 0 Bits [31:0] Output frequency in Hertz

Notes: Sets the output frequency of the output selected in 0xE0008000 if one of OUT1 or OUT2 has been chosen as a single output. If either Ethernet modes has been selected then this register is ignored and does nothing on a write and reads back as zero.

Notes: Setting this register will cause the ACS1790 output frequency to jump immediately if the device has already been configured. If not, the changes will be applied when 0xE0008000 is written.
0xE0008003 Reserved - - Reserved
0xE0008004 Configure OUT2 drive strength and slew rate RW 0 Bits [31:2] Reserved
Bit [1] Valid bit values are:
0 the OUT2 CMOS clock output will operate at the 1.8V LVCMOS standard.
1 the OUT2 CMOS clock output will operate at either the 2.5V or 3.3V LVCMOS standard.
Bit [0] 0 the OUT2 signal is driven with slow rise and fall times.
1 the OUT2 signal is driven with fast rise and fall times.

Notes: The OUT2 CMOS clock output can operate at either 1.8V or 2.5V or 3.3V. The signal can be driven with “fast” or “slow” rise and fall times. Refer to the ACS1790 for further clarification. Effect of write is immediate.

Notes: Setting this register will cause the OUT2 settings to be applied immediately if the device has already been configured. If not, the changes will be applied when 0xE0008000 is written.

Notes: If the 1790 device is not present then data returned will not be valid.
0xE0008005 Read 1790 status register RO As per 1790 data sheet Register definition is as per the 1790 data sheet...
Bits[31:7] Reserved
Bit[6] Mode
Bit[5] Oscfsel1
Bit[4] Oscfsel0
Bit[3] a0
Bit[2] a1
Bit[1] oeb
Bit[0] lock
0xE0008006 Get/Set auto-squelch behaviour RW 0 Bits[31:2] Reserved
Bit[1] FBCLK auto squelch. '1' implies auto squelch is enabled. '0' implies disabled.
Bit[0] OUT1 and OUT2 auto squelch. '1' implies auto squelch is enabled. '0' implies disabled.

Warning: The auto-squelch behaviour is disabled by default. It is safe to override the OUT1 and OUT2 auto-squelch behaviour, however FBCLK must not be overriden when using closed loop mode.

Notes: If the 1790 device is not present then data returned will not be valid.
0xE0008007 Reserved - - Reserved
0xE0008008 Reserved - - Reserved
0xE0008009 Reserved - - Reserved
0xE000800A Reserved - - Reserved
0xE000800B Reserved - - Reserved
0xE000800C Reserved - - Reserved
0xE000800D Reserved - - Reserved
0xE000800E Reserved - - Reserved
0xE000800F Reserved - - Reserved
0xE0008010 Reserved - - Reserved
0xE0008011 Reserved - - Reserved
0xE0008012 Reserved - - Reserved
0xE0008013 Reserved - - Reserved
0xE0008014 Reserved - - Reserved
0xE0008015 Reserved - - Reserved
0xE0008016 tDivFrequency RW 0 Bits[31:0] if this is non zero then this frequency is used as the tDiv Frequency instead of any calculations
0xE0008020 the vco freq to be used when enabled thus overriding any calculations RW 0 Bits[31:0] frequency
This is used when register 0xE0008024 is subsequently enabled
0xE0008021 contains the O divider value to be used when enabled thus overriding any calculations RW 0 Bits[31:0] O div value
This is used when register 0xE0008024 is subsequently enabled
0xE0008022 contains the B/P divider value to be used when enabled thus overriding any calculations RW 0 Bits[31:0] B div value
This is used when register 0xE0008024 is subsequently enabled
0xE0008023 scaling factor to be used when disciplining slave when using the overrides RW 0 Bits[31:0] float value.
This is only used when 0xE0008024 is enabled and this value is non zero.
To discipline the slave then this value should be set on the master.
0xE0008024 enables the VCO and divider overrides above RW 0 Bits[31:1] reserved
Bits[0] when this register is written to with a '1' value then the overrides above are enabled and used.